Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config

Class CmdLineException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

org.tquadrat.foundation.exception.ValidationException

org.tquadrat.foundation.config.CmdLineException

All Implemented Interfaces:

Serializable

@ClassVersion(sourceVersion="$Id: CmdLineException.java 1078 2023-10-19 14:39:47Z tquadrat $")
@API(status=STABLE,
     since="0.0.1")
public final class CmdLineException
extends ValidationException

Signals an error in the user input.

The message keys corresponds to the current default message by the suffix: the default message for MSGKEY_Aborted is MSG_Aborted and so on.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Thanks to:

Kohsuke Kawaguchi (kk@kohsuke.org)

Version:

$Id: CmdLineException.java 1078 2023-10-19 14:39:47Z tquadrat $

Since:

0.0.1

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.CmdLineException"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Optional<CLIDefinition>	m_CLIDefinition	The CLI definition for the argument/option that caused this exception.
private final Object[]	m_MessageArguments	The arguments for the message that is retrieved with the m_MessageKey.
private final int	m_MessageKey	The message key.
static final String	MSG_Aborted	The default error message: "The command line parsing was aborted due to an exception: %1$s".
static final String	MSG_ArgumentMissing	The error message for an argument that is missing on the command line: "The mandatory argument \'%1$s\' is missing on the command line".
static final String	MSG_IllegalOperand	The error message for an illegal option argument: "\'%2$s\' is not a valid value for \'%1$s\'".
static final String	MSG_InvalidFileName	The error message for an invalid file name on the command line: "\'%s\' cannot be parsed as a valid file name".
static final String	MSG_InvalidFormat	The error message for an invalid format: "The date format pattern \'%1$s\' is not valid".
static final String	MSG_MissingOperand	The error message for a missing option argument: "Option \'%1$s\' requires an argument".
static final String	MSG_NoArgumentAllowed	The error message for an argument where none is allowed: "No arguments allowed: %1$s".
static final String	MSG_OptionInvalid	The error message for an invalid option: "The option \'%1$s\' is invalid".
static final String	MSG_OptionMissing	The error message for a mandatory option that is missing on the command line: "The mandatory option \'%1$s\' is missing on the command line".
static final String	MSG_ParseFailed	The message for an unspecified failure of the command line parsing: "Parsing the command line failed".
static final String	MSG_TooManyArguments	The error message for too many arguments on the command line: "Too many arguments provided: %1$s".
static final int	MSGKEY_Aborted	The message key for the default error message.
static final int	MSGKEY_ArgumentMissing	The message key for the error message about an argument that is missing on the command line.
static final int	MSGKEY_IllegalOperand	The message key for an error message about an illegal operand.
static final int	MSGKEY_InvalidFileName	The resource bundle key for the message about an invalid file name String on the command line.
static final int	MSGKEY_InvalidFormat	The message key for an error message about an invalid format.
static final int	MSGKEY_MissingOperand	The message key for an error message about a missing option argument.
static final int	MSGKEY_NoArgumentAllowed	The message key for an error message about an argument where none is allowed.
static final int	MSGKEY_OptionInvalid	The message key for the error message about an invalid option.
static final int	MSGKEY_OptionMissing	The message key for the error message about an option that is missing on the command line.
static final int	MSGKEY_ParseFailed	The message key for the message about an unspecified failure of the parsing.
static final int	MSGKEY_TooManyArguments	The message key for the error message about too many arguments on the command line.
private static final long	serialVersionUID	The serial version UID for objects of this class: -8574071211991372980L.

Fields inherited from class org.tquadrat.foundation.exception.ValidationException

MSG_ValidationFailed

Constructor Summary

Constructors

Constructor	Description
CmdLineException(String message, int messageKey, Object... messageArguments)	Creates a new CmdLineException instance.
CmdLineException(String message, Throwable cause, int messageKey, Object... messageArguments)	Creates a new CmdLineException instance.
CmdLineException(Throwable cause)	Creates a new CmdLineException instance.
CmdLineException(Optional<CLIDefinition> cliDefinition, Throwable cause)	Creates a new CmdLineException instance.
CmdLineException(CLIDefinition cliDefinition, String message, int messageKey, Object... messageArguments)	Creates a new CmdLineException instance.
CmdLineException(CLIDefinition cliDefinition, String message, Throwable cause, int messageKey, Object... messageArguments)	Creates a new CmdLineException instance.
CmdLineException(CLIDefinition cliDefinition, Throwable cause)	Creates a new CmdLineException instance.

Method Summary

Modifier and Type	Method	Description
final Throwable	fillInStackTrace()
final Optional<CLIDefinition>	getCLIDefinition()	Returns the CLIDefinition that triggered the exception.
final String	getLocalizedMessage()
final Object[]	getMessageArguments()	Returns the message arguments.
final int	getMessageKey()	Returns the resource bundle key for the alternative message.

Methods inherited from class java.lang.Throwable

addSuppressed, getCause, 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

Field Details

MSG_Aborted

public static final String MSG_Aborted

The default error message: "The command line parsing was aborted due to an exception: %1$s".

See Also:

• Constant Field Values

MSG_ArgumentMissing

public static final String MSG_ArgumentMissing

The error message for an argument that is missing on the command line: "The mandatory argument \'%1$s\' is missing on the command line".

See Also:

• Constant Field Values

MSG_IllegalOperand

public static final String MSG_IllegalOperand

The error message for an illegal option argument: "\'%2$s\' is not a valid value for \'%1$s\'".

See Also:

• Constant Field Values

MSG_InvalidFileName

public static final String MSG_InvalidFileName

The error message for an invalid file name on the command line: "\'%s\' cannot be parsed as a valid file name".

See Also:

• Constant Field Values

MSG_InvalidFormat

public static final String MSG_InvalidFormat

The error message for an invalid format: "The date format pattern \'%1$s\' is not valid".

See Also:

• Constant Field Values

MSG_MissingOperand

public static final String MSG_MissingOperand

The error message for a missing option argument: "Option \'%1$s\' requires an argument".

See Also:

• Constant Field Values

MSG_NoArgumentAllowed

public static final String MSG_NoArgumentAllowed

The error message for an argument where none is allowed: "No arguments allowed: %1$s".

See Also:

• Constant Field Values

MSG_OptionInvalid

public static final String MSG_OptionInvalid

The error message for an invalid option: "The option \'%1$s\' is invalid".

See Also:

• Constant Field Values

MSG_OptionMissing

public static final String MSG_OptionMissing

The error message for a mandatory option that is missing on the command line: "The mandatory option \'%1$s\' is missing on the command line".

See Also:

• Constant Field Values

MSG_ParseFailed

public static final String MSG_ParseFailed

The message for an unspecified failure of the command line parsing: "Parsing the command line failed".

See Also:

• Constant Field Values

MSG_TooManyArguments

public static final String MSG_TooManyArguments

The error message for too many arguments on the command line: "Too many arguments provided: %1$s".

See Also:

• Constant Field Values

MSGKEY_Aborted

public static final int MSGKEY_Aborted

The message key for the default error message.

See Also:

• MSG_Aborted
• Constant Field Values

MSGKEY_ArgumentMissing

public static final int MSGKEY_ArgumentMissing

The message key for the error message about an argument that is missing on the command line.

See Also:

• MSG_ArgumentMissing
• Constant Field Values

MSGKEY_IllegalOperand

public static final int MSGKEY_IllegalOperand

The message key for an error message about an illegal operand.

See Also:

• MSG_IllegalOperand
• Constant Field Values

MSGKEY_InvalidFileName

public static final int MSGKEY_InvalidFileName

The resource bundle key for the message about an invalid file name String on the command line.

See Also:

• Constant Field Values

MSGKEY_InvalidFormat

public static final int MSGKEY_InvalidFormat

The message key for an error message about an invalid format.

See Also:

• MSG_InvalidFormat
• Constant Field Values

MSGKEY_MissingOperand

public static final int MSGKEY_MissingOperand

The message key for an error message about a missing option argument.

See Also:

• MSG_MissingOperand
• Constant Field Values

MSGKEY_NoArgumentAllowed

public static final int MSGKEY_NoArgumentAllowed

The message key for an error message about an argument where none is allowed.

See Also:

• MSG_NoArgumentAllowed
• Constant Field Values

MSGKEY_OptionInvalid

public static final int MSGKEY_OptionInvalid

The message key for the error message about an invalid option.

See Also:

• MSG_OptionInvalid
• Constant Field Values

MSGKEY_OptionMissing

public static final int MSGKEY_OptionMissing

The message key for the error message about an option that is missing on the command line.

See Also:

• MSG_OptionMissing
• Constant Field Values

MSGKEY_ParseFailed

public static final int MSGKEY_ParseFailed

The message key for the message about an unspecified failure of the parsing.

See Also:

• MSG_ParseFailed
• Constant Field Values

MSGKEY_TooManyArguments

public static final int MSGKEY_TooManyArguments

The message key for the error message about too many arguments on the command line.

See Also:

• MSG_TooManyArguments
• Constant Field Values

m_CLIDefinition

private final Optional<CLIDefinition> m_CLIDefinition

The CLI definition for the argument/option that caused this exception.

m_MessageArguments

private final Object[] m_MessageArguments

The arguments for the message that is retrieved with the m_MessageKey.

m_MessageKey

private final int m_MessageKey

The message key.

serialVersionUID

private static final long serialVersionUID

The serial version UID for objects of this class: -8574071211991372980L.

See Also:

• Constant Field Values

Constructor Details

CmdLineException

public CmdLineException(String message,
 int messageKey,
 Object... messageArguments)

Creates a new CmdLineException instance.

Parameters:

message - The error message.

messageKey - The resource bundle key for an alternative message.

messageArguments - The arguments for the generation of the alternative message.

CmdLineException

public CmdLineException(CLIDefinition cliDefinition,
 String message,
 int messageKey,
 Object... messageArguments)

Creates a new CmdLineException instance.

Parameters:

cliDefinition - The CLI definition for the argument/option that caused this exception.

message - The error message.

messageKey - The resource bundle key for an alternative message.

messageArguments - The arguments for the generation of the alternative message.

CmdLineException

public CmdLineException(String message,
 Throwable cause,
 int messageKey,
 Object... messageArguments)

Creates a new CmdLineException instance.

Parameters:

message - The error message.

cause - The exception that caused this exception.

messageKey - The resource bundle key for an alternative message.

messageArguments - The arguments for the generation of the alternative message.

CmdLineException

public CmdLineException(CLIDefinition cliDefinition,
 String message,
 Throwable cause,
 int messageKey,
 Object... messageArguments)

Creates a new CmdLineException instance.

Parameters:

cliDefinition - The CLI definition for the argument/option that caused this exception.

message - The error message.

cause - The exception that caused this exception.

messageKey - The resource bundle key for an alternative message.

messageArguments - The arguments for the generation of the alternative message.

CmdLineException

public CmdLineException(Throwable cause)

Creates a new CmdLineException instance.

Parameters:

cause - The exception that caused this exception.

CmdLineException

public CmdLineException(CLIDefinition cliDefinition,
 Throwable cause)

Creates a new CmdLineException instance.

Parameters:

cliDefinition - The CLI definition for the argument/option that caused this exception.

cause - The exception that caused this exception.

CmdLineException

public CmdLineException(Optional<CLIDefinition> cliDefinition,
 Throwable cause)

Creates a new CmdLineException instance.

Parameters:

cliDefinition - An instance of Optional that holds the CLI definition for the argument/option that caused this exception.

cause - The exception that caused this exception.

Method Details

fillInStackTrace

public final Throwable fillInStackTrace()

Overrides:

fillInStackTrace in class Throwable

getCLIDefinition

public final Optional<CLIDefinition> getCLIDefinition()

Returns the CLIDefinition that triggered the exception.

Returns:

An instance of Optional that holds the CLI definition.

getLocalizedMessage

public final String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable

getMessageArguments

public final Object[] getMessageArguments()

Returns the message arguments.

Returns:

The message arguments.

getMessageKey

public final int getMessageKey()

Returns the resource bundle key for the alternative message.

Returns:

The message key.