de.carne.util.cmdline

Class CmdLineActionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

de.carne.util.cmdline.CmdLineActionException

All Implemented Interfaces:

java.io.Serializable

public class CmdLineActionException
extends java.lang.RuntimeException

This exception indicates a problem while invoking a command line action CmdLineAction.

This exception can be thrown by the command line action's consumer expressions to indicate a problem during command line evaluation. The command line evaluation is stopped as soon as this exception is encountered.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CmdLineActionException(java.lang.String arg) Construct CmdLineActionException.
CmdLineActionException(java.lang.String arg, java.lang.String option) Construct CmdLineActionException.
CmdLineActionException(java.lang.String arg, java.lang.String option, java.lang.Throwable cause) Construct CmdLineActionException.
CmdLineActionException(java.lang.String arg, java.lang.Throwable cause) Construct CmdLineActionException.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArg() Get the causing argument.
java.lang.String	getOption() Get the argument option (if existent).

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

Constructor Detail

CmdLineActionException

public CmdLineActionException(java.lang.String arg)

Construct CmdLineActionException.

Parameters:

arg - The causing argument.

CmdLineActionException

public CmdLineActionException(java.lang.String arg,
                              java.lang.Throwable cause)

Construct CmdLineActionException.

Parameters:

arg - The causing argument.

cause - The causing exception.

CmdLineActionException

public CmdLineActionException(java.lang.String arg,
                              java.lang.String option)

Construct CmdLineActionException.

Parameters:

arg - The causing argument.

option - The option argument option.

CmdLineActionException

public CmdLineActionException(java.lang.String arg,
                              @Nullable
                              java.lang.String option,
                              @Nullable
                              java.lang.Throwable cause)

Construct CmdLineActionException.

Parameters:

arg - The causing argument.

option - The option argument option.

cause - The causing exception.

Method Detail

getArg

public java.lang.String getArg()

Get the causing argument.

Returns:

The causing argument.

getOption

@Nullable
public java.lang.String getOption()

Get the argument option (if existent).

Returns:

The argument option (may be null).