Module com.github.sttk.cliargs

Package com.github.sttk.cliargs.exceptions

Class OptionArgIsInvalid

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.github.sttk.cliargs.exceptions.InvalidOption

com.github.sttk.cliargs.exceptions.OptionArgIsInvalid

All Implemented Interfaces:

Serializable

public class OptionArgIsInvalid
extends InvalidOption

Is the exception which indicates that the option argument is invalidated by the validator in the option configuration.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final String	details	The details for the invalidation.
final String	optArg	The option argument that was validated.
final String	option	The option name that caused this exception.
final String	storeKey	The store key of the option configuration that caused this exception.

Constructor Summary

Constructors

Constructor	Description
OptionArgIsInvalid(String storeKey, String option, String optArg, String details, Throwable cause)	Constructs an instance of this class.

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Returns a string which represents the content of this exception.
String	option()	Gets the option name that caused this exception.

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

Field Details

storeKey

public final String storeKey

The store key of the option configuration that caused this exception.

option

public final String option

The option name that caused this exception.

optArg

public final String optArg

The option argument that was validated.

details

public final String details

The details for the invalidation.

Constructor Details

OptionArgIsInvalid

public OptionArgIsInvalid(String storeKey,
 String option,
 String optArg,
 String details,
 Throwable cause)

Constructs an instance of this class.

Parameters:

storeKey - The store key of the option configuration that caused this exception.

option - The option name that caused this exception.

optArg - The option argument that as validated.

details - The details for the invalidation.

cause - The cause of this exception.

Method Details

option

public String option()

Gets the option name that caused this exception.

Specified by:

option in class InvalidOption

Returns:

The option name.

getMessage

public String getMessage()

Returns a string which represents the content of this exception.

Overrides:

getMessage in class Throwable

Returns:

The exception message.