Module org.refcodes.cli

Package org.refcodes.cli

Class ArgsSyntaxException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.refcodes.exception.AbstractException

org.refcodes.cli.CliException

org.refcodes.cli.CliException.ConsoleArgsException

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.ConsoleArgsException
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.ConsoleArgsException, CliException.ConsoleCliException

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.SourceMutator<SRC extends Object>, org.refcodes.mixin.SourceAccessor.SourceProperty<SRC extends Object>

Constructor Summary

Constructors

Constructor	Description
ArgsSyntaxException(String[] aArgs, String aMessage)	Instantiates a new ArgsSyntaxException exception.
ArgsSyntaxException(String[] aArgs, String aMessage, String aErrorCode)	Instantiates a new ArgsSyntaxException exception.
ArgsSyntaxException(String[] aArgs, String aMessage, String aErrorCode, Term aSource)	Instantiates a new ArgsSyntaxException exception.
ArgsSyntaxException(String[] aArgs, String aMessage, Throwable aCause)	Instantiates a new ArgsSyntaxException exception.
ArgsSyntaxException(String[] aArgs, String aMessage, Throwable aCause, String aErrorCode)	Instantiates a new ArgsSyntaxException exception.
ArgsSyntaxException(String[] aArgs, String aMessage, Throwable aCause, String aErrorCode, Term aSource)	Instantiates a new ArgsSyntaxException exception.
ArgsSyntaxException(String[] aArgs, String aMessage, Throwable aCause, Term aSource)	Instantiates a new ArgsSyntaxException exception.
ArgsSyntaxException(String[] aArgs, String aMessage, Term aSource)	Instantiates a new ArgsSyntaxException exception.
ArgsSyntaxException(String[] aArgs, Throwable aCause)	Instantiates a new ArgsSyntaxException exception.
ArgsSyntaxException(String[] aArgs, Throwable aCause, String aErrorCode)	Instantiates a new ArgsSyntaxException exception.
ArgsSyntaxException(String[] aArgs, Throwable aCause, String aErrorCode, Term aSource)	Instantiates a new ArgsSyntaxException exception.
ArgsSyntaxException(String[] aArgs, Throwable aCause, Term aSource)	Instantiates a new ArgsSyntaxException exception.

Method Summary

Modifier and Type	Method	Description
int	getMatchCount()	Determines the number of args being matched upon encountering this exception.
Term	getSource()	Returns the Term responsible for this exception.
String	toHeuristicMessage()	Tries to determine the most likely cause 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.ConsoleArgsException

getArgs

Methods inherited from class org.refcodes.exception.AbstractException

getErrorCode

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

Methods inherited from interface org.refcodes.exception.Trap

toLocalizedMessage, toMessage, toShortLocalizedMessage, toShortMessage

Constructor Details

ArgsSyntaxException

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

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aMessage - The aMessage describing this exception.

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

ArgsSyntaxException

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

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aMessage - The aMessage describing this exception.

aErrorCode - The error code identifying this exception.

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

ArgsSyntaxException

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

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aMessage - The aMessage describing this exception.

aCause - The Throwable (Exception) causing this exception.

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

ArgsSyntaxException

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

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aMessage - The aMessage describing this exception.

aCause - The Throwable (Exception) causing this exception.

aErrorCode - The error code identifying this exception.

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

ArgsSyntaxException

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

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aCause - The Throwable (Exception) causing this exception.

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

ArgsSyntaxException

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

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aCause - The Throwable (Exception) causing this exception.

aErrorCode - The error code identifying this exception.

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

ArgsSyntaxException

public ArgsSyntaxException(String[] aArgs,
 String aMessage)

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aMessage - The aMessage describing this exception.

ArgsSyntaxException

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

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aMessage - The aMessage describing this exception.

aErrorCode - The error code identifying this exception.

ArgsSyntaxException

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

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aMessage - The aMessage describing this exception.

aCause - The Throwable (Exception) causing this exception.

ArgsSyntaxException

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

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aMessage - The aMessage describing this exception.

aCause - The Throwable (Exception) causing this exception.

aErrorCode - The error code identifying this exception.

ArgsSyntaxException

public ArgsSyntaxException(String[] aArgs,
 Throwable aCause)

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aCause - The Throwable (Exception) causing this exception.

ArgsSyntaxException

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

Instantiates a new ArgsSyntaxException exception.

Parameters:

aArgs - The arguments participating in the exception.

aCause - The Throwable (Exception) causing this exception.

aErrorCode - The error code identifying this exception.

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 likely cause 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. Throwable.getSuppressed() exceptions, the cause Throwable.getCause() is at a CHILD level of THIS exception, the cause's suppressed exceptions are at the SAME level as the cause itself. A wrong idea of the hierarchy of exceptions has erroneously been implemented, this implementation got to corrected as described.

Returns:

The heuristic 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.