com.hp.util.syntax

Class BadUsageException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.text.ParseException

com.hp.util.syntax.BadUsageException

All Implemented Interfaces:

Serializable

public class BadUsageException
extends ParseException

Exception representing a problem during parsing of a parameter.

Author:

Thomas Vachuska

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BadUsageException(String message, int errorOffset, Syntax syntax, SyntaxNode syntaxNode) Constructs a new exception representing a keyword mismatch.

Method Summary

Modifier and Type	Method and Description
Syntax	getSyntax() Get the syntax whose usage was violated.
SyntaxNode	getSyntaxNode() Get the specific syntax node which caused the parsing failure.

Methods inherited from class java.text.ParseException

getErrorOffset

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BadUsageException

public BadUsageException(String message,
                         int errorOffset,
                         Syntax syntax,
                         SyntaxNode syntaxNode)

Constructs a new exception representing a keyword mismatch.

Parameters:

message - Detailed error message.

errorOffset - Argument position where the mismatch occurred.

syntax - Syntax entity representing the closest match.

syntaxNode - SyntaxNode entity that caused the mismatch.

Method Detail

getSyntax

public Syntax getSyntax()

Get the syntax whose usage was violated.

Returns:

Syntax representing the closest match.

getSyntaxNode

public SyntaxNode getSyntaxNode()

Get the specific syntax node which caused the parsing failure.

Returns:

SyntaxNode that caused the mismatch.