Class CliException.CliArgsException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.refcodes.exception.AbstractException

org.refcodes.cli.CliException

org.refcodes.cli.CliException.CliArgsException

All Implemented Interfaces:

Serializable, ArgsAccessor, ErrorCodeAccessor, Trap

Direct Known Subclasses:

ArgsSyntaxException

Enclosing class:

CliException

public abstract static class CliException.CliArgsException
extends CliException
implements ArgsAccessor

This abstract exception is the base exception for all command line argument related exceptions.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class CliException

CliException.CliArgsException

Nested classes/interfaces inherited from interface ArgsAccessor

ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty

Nested classes/interfaces inherited from interface ErrorCodeAccessor

ErrorCodeAccessor.ErrorCodeBuilder<B>, ErrorCodeAccessor.ErrorCodeMutator, ErrorCodeAccessor.ErrorCodeProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	_args

Constructor Summary

Constructors

Constructor	Description
CliArgsException(String[] aArgs, Throwable aCause)	Instantiates the class CliException.CliArgsException.
CliArgsException(String[] aArgs, Throwable aCause, String aErrorCode)	Instantiates the class CliException.CliArgsException.
CliArgsException(String aMessage, String[] aArgs)	Instantiates the class CliException.CliArgsException.
CliArgsException(String aMessage, String[] aArgs, String aErrorCode)	Instantiates the class CliException.CliArgsException.
CliArgsException(String aMessage, String[] aArgs, Throwable aCause)	Instantiates the class CliException.CliArgsException.
CliArgsException(String aMessage, String[] aArgs, Throwable aCause, String aErrorCode)	Instantiates the class CliException.CliArgsException.

Method Summary

Modifier and Type	Method	Description
String[]	getArgs()	Retrieves the command line arguments from the args property.
Object[]	getPatternArguments()

Methods inherited from class AbstractException

getErrorCode, getMessage

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Methods inherited from interface Trap

toLocalizedMessage, toMessage, toMessage, toMessage, toShortLocalizedMessage, toShortMessage

Field Details

_args

protected String[] _args

Constructor Details

CliArgsException

public CliArgsException(String aMessage,
 String[] aArgs)

Instantiates the class CliException.CliArgsException.

Parameters:

aArgs - The command line arguments involved in this exception.

See Also:

• CliException(String)

CliArgsException

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

Instantiates the class CliException.CliArgsException.

Parameters:

aArgs - The command line arguments involved in this exception.

See Also:

• CliException(String, String)

CliArgsException

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

Instantiates the class CliException.CliArgsException.

Parameters:

aArgs - The command line arguments involved in this exception.

See Also:

• CliException(String, Throwable)

CliArgsException

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

Instantiates the class CliException.CliArgsException.

Parameters:

aArgs - The command line arguments involved in this exception.

See Also:

• CliException(String, Throwable, String)

CliArgsException

public CliArgsException(String[] aArgs,
 Throwable aCause)

Instantiates the class CliException.CliArgsException.

Parameters:

aArgs - The command line arguments involved in this exception.

See Also:

• CliException(Throwable)

CliArgsException

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

Instantiates the class CliException.CliArgsException.

Parameters:

aArgs - The command line arguments involved in this exception.

See Also:

• CliException(Throwable, String)

Method Details

getArgs

public String[] getArgs()

Retrieves the command line arguments from the args property.

Specified by:

getArgs in interface ArgsAccessor

Returns:

The command line arguments stored by the args property.

getPatternArguments

public Object[] getPatternArguments()

Specified by:

getPatternArguments in interface Trap