Module org.refcodes.cli

Package org.refcodes.cli

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, org.refcodes.exception.ErrorCodeAccessor, org.refcodes.exception.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 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

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	_args

Constructor Summary

Constructors

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

Method Summary

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

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

_args

protected String[] _args

Constructor Details

CliArgsException

public CliArgsException(String aMessage,
 String[] aArgs)

Parameters:

aArgs - The command line arguments involved in this exception.

CliArgsException

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

Parameters:

aArgs - The command line arguments involved in this exception.

CliArgsException

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

Parameters:

aArgs - The command line arguments involved in this exception.

CliArgsException

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

Parameters:

aArgs - The command line arguments involved in this exception.

CliArgsException

public CliArgsException(String[] aArgs,
 Throwable aCause)

Parameters:

aArgs - The command line arguments involved in this exception.

CliArgsException

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

Parameters:

aArgs - The command line arguments involved in this exception.

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 org.refcodes.exception.Trap