Class ArgsSyntaxException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.refcodes.exception.AbstractException

org.refcodes.cli.CliException

org.refcodes.cli.CliException.CliArgsException

org.refcodes.cli.ArgsSyntaxException

All Implemented Interfaces:

Serializable, ArgsAccessor, MatchCountAccessor, org.refcodes.exception.ErrorCodeAccessor, org.refcodes.exception.Trap, org.refcodes.mixin.SourceAccessor<Term>

Direct Known Subclasses:

AmbiguousArgsException, ParseArgsException, SuperfluousArgsException, UnknownArgsException

public class ArgsSyntaxException
extends CliException.CliArgsException
implements org.refcodes.mixin.SourceAccessor<Term>, MatchCountAccessor

Thrown in case of a command line arguments mismatch regarding provided and expected args.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.refcodes.cli.CliException

CliException.CliArgsException

Nested classes/interfaces inherited from interface org.refcodes.cli.ArgsAccessor

ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty

Nested classes/interfaces inherited from interface org.refcodes.exception.ErrorCodeAccessor

org.refcodes.exception.ErrorCodeAccessor.ErrorCodeBuilder<B extends org.refcodes.exception.ErrorCodeAccessor.ErrorCodeBuilder<B>>, org.refcodes.exception.ErrorCodeAccessor.ErrorCodeMutator, org.refcodes.exception.ErrorCodeAccessor.ErrorCodeProperty

Nested classes/interfaces inherited from interface org.refcodes.cli.MatchCountAccessor

MatchCountAccessor.MatchCountBuilder<B extends MatchCountAccessor.MatchCountBuilder<B>>, MatchCountAccessor.MatchCountMutator, MatchCountAccessor.MatchCountProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.SourceAccessor

org.refcodes.mixin.SourceAccessor.SourceBuilder<SRC,B extends org.refcodes.mixin.SourceAccessor.SourceBuilder<SRC,B>>, org.refcodes.mixin.SourceAccessor.SourceMutator<SRC>, org.refcodes.mixin.SourceAccessor.SourceProperty<SRC>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	_matchCount
protected Term	_source

Fields inherited from class org.refcodes.cli.CliException.CliArgsException

_args

Constructor Summary

Constructors

Constructor	Description
ArgsSyntaxException(String[] aArgs, Throwable aCause)	Instantiates the class ArgsSyntaxException.
ArgsSyntaxException(String[] aArgs, Throwable aCause, String aErrorCode)	Instantiates the class ArgsSyntaxException.
ArgsSyntaxException(String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class ArgsSyntaxException.
ArgsSyntaxException(String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	Instantiates the class ArgsSyntaxException.
ArgsSyntaxException(String aMessage, String[] aArgs)	Instantiates the class ArgsSyntaxException.
ArgsSyntaxException(String aMessage, String[] aArgs, String aErrorCode)	Instantiates the class ArgsSyntaxException.
ArgsSyntaxException(String aMessage, String[] aArgs, Throwable aCause)	Instantiates the class ArgsSyntaxException.
ArgsSyntaxException(String aMessage, String[] aArgs, Throwable aCause, String aErrorCode)	Instantiates the class ArgsSyntaxException.
ArgsSyntaxException(String aMessage, String[] aArgs, Term aSource)	Instantiates the class ArgsSyntaxException.
ArgsSyntaxException(String aMessage, String[] aArgs, Term aSource, String aErrorCode)	Instantiates the class ArgsSyntaxException.
ArgsSyntaxException(String aMessage, String[] aArgs, Term aSource, Throwable aCause)	Instantiates the class ArgsSyntaxException.
ArgsSyntaxException(String aMessage, String[] aArgs, Term aSource, Throwable aCause, String aErrorCode)	Instantiates the class ArgsSyntaxException.

Method Summary

Modifier and Type	Method	Description
int	getMatchCount()	Determines the number of args being matched upon encountering this exception.
Object[]	getPatternArguments()
Term	getSource()	Returns the Term responsible for this exception.
String	toHeuristicMessage()	Tries to determine the most verbose description of this exception by crawling the exception tree down the causes and suppressed exceptions and evaluating their Term source's Term.getMatchCount() argument match counts.
ArgsSyntaxException	toRootMatchCause()	Determines the root cause of this exception with the same match count (getMatchCount()) as this exception.

Methods inherited from class org.refcodes.cli.CliException.CliArgsException

getArgs

Methods inherited from class org.refcodes.exception.AbstractException

getErrorCode, getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

Methods inherited from interface org.refcodes.exception.Trap

toLocalizedMessage, toMessage, toMessage, toMessage, toShortLocalizedMessage, toShortMessage

Field Details

_source

protected Term _source

_matchCount

protected int _matchCount

Constructor Details

ArgsSyntaxException

public ArgsSyntaxException(String aMessage,
 String[] aArgs,
 Term aSource)

Instantiates the class ArgsSyntaxException.

Parameters:

aSource - The Term responsible for this exception (source).

See Also:

• CliArgsException(String, String[])

ArgsSyntaxException

public ArgsSyntaxException(String aMessage,
 String[] aArgs,
 Term aSource,
 String aErrorCode)

Instantiates the class ArgsSyntaxException.

Parameters:

aSource - The Term responsible for this exception (source).

See Also:

• CliArgsException(String, String[], String)

ArgsSyntaxException

public ArgsSyntaxException(String aMessage,
 String[] aArgs,
 Term aSource,
 Throwable aCause)

Instantiates the class ArgsSyntaxException.

Parameters:

aSource - The Term responsible for this exception (source).

See Also:

• CliArgsException(String, String[], Throwable)

ArgsSyntaxException

public ArgsSyntaxException(String aMessage,
 String[] aArgs,
 Term aSource,
 Throwable aCause,
 String aErrorCode)

Instantiates the class ArgsSyntaxException.

Parameters:

aSource - The Term responsible for this exception (source).

See Also:

• CliArgsException(String, String[], Throwable, String)

ArgsSyntaxException

public ArgsSyntaxException(String[] aArgs,
 Term aSource,
 Throwable aCause)

Instantiates the class ArgsSyntaxException.

Parameters:

aSource - The Term responsible for this exception (source).

See Also:

• CliArgsException(String[], Throwable)

ArgsSyntaxException

public ArgsSyntaxException(String[] aArgs,
 Term aSource,
 Throwable aCause,
 String aErrorCode)

Instantiates the class ArgsSyntaxException.

Parameters:

aSource - The Term responsible for this exception (source).

See Also:

• CliArgsException(String[], Throwable, String)

ArgsSyntaxException

public ArgsSyntaxException(String aMessage,
 String[] aArgs)

Instantiates the class ArgsSyntaxException.

See Also:

• CliArgsException(String, String[])

ArgsSyntaxException

public ArgsSyntaxException(String aMessage,
 String[] aArgs,
 String aErrorCode)

Instantiates the class ArgsSyntaxException.

See Also:

• CliArgsException(String, String[], String)

ArgsSyntaxException

public ArgsSyntaxException(String aMessage,
 String[] aArgs,
 Throwable aCause)

Instantiates the class ArgsSyntaxException.

See Also:

• CliArgsException(String, String[], Throwable)

ArgsSyntaxException

public ArgsSyntaxException(String aMessage,
 String[] aArgs,
 Throwable aCause,
 String aErrorCode)

Instantiates the class ArgsSyntaxException.

See Also:

• CliArgsException(String, String[], Throwable, String)

ArgsSyntaxException

public ArgsSyntaxException(String[] aArgs,
 Throwable aCause)

Instantiates the class ArgsSyntaxException.

See Also:

• CliArgsException(String[], Throwable)

ArgsSyntaxException

public ArgsSyntaxException(String[] aArgs,
 Throwable aCause,
 String aErrorCode)

Instantiates the class ArgsSyntaxException.

See Also:

• CliArgsException(String[], Throwable, String)

Method Details

getMatchCount

public int getMatchCount()

Determines the number of args being matched upon encountering this exception.

Specified by:

getMatchCount in interface MatchCountAccessor

Returns:

The number of args matching till this exception occurred.

getSource

public Term getSource()

Returns the Term responsible for this exception.

Specified by:

getSource in interface org.refcodes.mixin.SourceAccessor<Term>

Returns:

The Term where this exception occurred.

toHeuristicMessage

public String toHeuristicMessage()

Tries to determine the most verbose description of this exception by crawling the exception tree down the causes and suppressed exceptions and evaluating their Term source's Term.getMatchCount() argument match counts.

Returns:

The heuristic and verbose cause of this exception.

toRootMatchCause

public ArgsSyntaxException toRootMatchCause()

Determines the root cause of this exception with the same match count (getMatchCount()) as this exception.

Returns:

The actual root cause of this exception or this exception if no (more specific) root cause was determined.

getPatternArguments

public Object[] getPatternArguments()

Specified by:

getPatternArguments in interface org.refcodes.exception.Trap

Overrides:

getPatternArguments in class CliException.CliArgsException