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:
-
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
-
Constructor Summary
ConstructorDescriptionArgsSyntaxException
(String[] aArgs, String aMessage) Instantiates a newArgsSyntaxException
exception.ArgsSyntaxException
(String[] aArgs, String aMessage, String aErrorCode) Instantiates a newArgsSyntaxException
exception.ArgsSyntaxException
(String[] aArgs, String aMessage, String aErrorCode, Term aSource) Instantiates a newArgsSyntaxException
exception.ArgsSyntaxException
(String[] aArgs, String aMessage, Throwable aCause) Instantiates a newArgsSyntaxException
exception.ArgsSyntaxException
(String[] aArgs, String aMessage, Throwable aCause, String aErrorCode) Instantiates a newArgsSyntaxException
exception.ArgsSyntaxException
(String[] aArgs, String aMessage, Throwable aCause, String aErrorCode, Term aSource) Instantiates a newArgsSyntaxException
exception.ArgsSyntaxException
(String[] aArgs, String aMessage, Throwable aCause, Term aSource) Instantiates a newArgsSyntaxException
exception.ArgsSyntaxException
(String[] aArgs, String aMessage, Term aSource) Instantiates a newArgsSyntaxException
exception.ArgsSyntaxException
(String[] aArgs, Throwable aCause) Instantiates a newArgsSyntaxException
exception.ArgsSyntaxException
(String[] aArgs, Throwable aCause, String aErrorCode) Instantiates a newArgsSyntaxException
exception.ArgsSyntaxException
(String[] aArgs, Throwable aCause, String aErrorCode, Term aSource) Instantiates a newArgsSyntaxException
exception.ArgsSyntaxException
(String[] aArgs, Throwable aCause, Term aSource) Instantiates a newArgsSyntaxException
exception. -
Method Summary
Modifier and TypeMethodDescriptionint
Determines the number of args being matched upon encountering this exception.Returns theTerm
responsible for this exception.Tries to determine the most likely cause of this exception by crawling the exception tree down the causes and suppressed exceptions and evaluating theirTerm
source'sTerm.getMatchCount()
argument match counts.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
Instantiates a newArgsSyntaxException
exception.- Parameters:
aArgs
- The arguments participating in the exception.aMessage
- The aMessage describing this exception.aSource
- TheTerm
responsible for this exception (source).
-
ArgsSyntaxException
Instantiates a newArgsSyntaxException
exception.- Parameters:
aArgs
- The arguments participating in the exception.aMessage
- The aMessage describing this exception.aErrorCode
- The error code identifying this exception.aSource
- TheTerm
responsible for this exception (source).
-
ArgsSyntaxException
Instantiates a newArgsSyntaxException
exception. -
ArgsSyntaxException
public ArgsSyntaxException(String[] aArgs, String aMessage, Throwable aCause, String aErrorCode, Term aSource) Instantiates a newArgsSyntaxException
exception. -
ArgsSyntaxException
Instantiates a newArgsSyntaxException
exception. -
ArgsSyntaxException
Instantiates a newArgsSyntaxException
exception. -
ArgsSyntaxException
Instantiates a newArgsSyntaxException
exception.- Parameters:
aArgs
- The arguments participating in the exception.aMessage
- The aMessage describing this exception.
-
ArgsSyntaxException
Instantiates a newArgsSyntaxException
exception.- Parameters:
aArgs
- The arguments participating in the exception.aMessage
- The aMessage describing this exception.aErrorCode
- The error code identifying this exception.
-
ArgsSyntaxException
Instantiates a newArgsSyntaxException
exception. -
ArgsSyntaxException
Instantiates a newArgsSyntaxException
exception. -
ArgsSyntaxException
Instantiates a newArgsSyntaxException
exception. -
ArgsSyntaxException
Instantiates a newArgsSyntaxException
exception.
-
-
Method Details
-
getMatchCount
public int getMatchCount()Determines the number of args being matched upon encountering this exception.- Specified by:
getMatchCount
in interfaceMatchCountAccessor
- Returns:
- The number of args matching till this exception occurred.
-
getSource
Returns theTerm
responsible for this exception. -
toHeuristicMessage
Tries to determine the most likely cause of this exception by crawling the exception tree down the causes and suppressed exceptions and evaluating theirTerm
source'sTerm.getMatchCount()
argument match counts.Throwable.getSuppressed()
exceptions, the causeThrowable.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
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.
-