Module com.github.sttk.cliargs

Package com.github.sttk.cliargs.exceptions

Class InvalidOption

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.github.sttk.cliargs.exceptions.InvalidOption

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConfigHasDefaultsButHasNoArg, ConfigIsArrayButHasNoArg, OptionArgIsInvalid, OptionContainsInvalidChar, OptionIsNotArray, OptionNameIsDuplicated, OptionNeedsArg, OptionTakesNoArg, StoreKeyIsDuplicated, UnconfiguredOption

public abstract class InvalidOption
extends Exception

Is the abstract class of the exception that provides a method to retrieve an option name.

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InvalidOption()	Constructs an instance of this class.
protected	InvalidOption(Throwable cause)	Constructs an instance of this class.

Method Summary

Modifier and Type	Method	Description
abstract String	option()	Gets the option name that caused this exception.

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 Details

InvalidOption

protected InvalidOption()

Constructs an instance of this class.

InvalidOption

protected InvalidOption(Throwable cause)

Constructs an instance of this class.

Parameters:

cause - The cause of this exception.

Method Details

option

public abstract String option()

Gets the option name that caused this exception.

Returns:

The option name.