Module com.github.sttk.cliargs

Package com.github.sttk.cliargs.exceptions

Class OptionNeedsArg

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.github.sttk.cliargs.exceptions.InvalidOption

com.github.sttk.cliargs.exceptions.OptionNeedsArg

All Implemented Interfaces:

Serializable

public class OptionNeedsArg
extends InvalidOption

Is the exception which indicates that the option requires arguments in the configuration, but no argument is specified.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
final String	option	The option name that caused this exception.
final String	storeKey	The store key.

Constructor Summary

Constructors

Constructor	Description
OptionNeedsArg(String option, String storeKey)	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

option

public final String option

The option name that caused this exception.

storeKey

public final String storeKey

The store key.

Constructor Details

OptionNeedsArg

public OptionNeedsArg(String option,
 String storeKey)

Constructs an instance of this class.

Parameters:

option - The option name that caused this exception.

storeKey - The store key.

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.