Package joptsimple

Class OptionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

joptsimple.OptionException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

IllegalOptionSpecificationException, MissingRequiredOptionsException, MultipleArgumentsForOptionException, OptionArgumentConversionException, OptionMissingRequiredArgumentException, UnavailableOptionException, UnconfiguredOptionException, UnrecognizedOptionException

public abstract class OptionException
extends java.lang.RuntimeException

Thrown when a problem occurs during option parsing.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<java.lang.String>	options
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OptionException(java.util.Collection<? extends OptionSpec<?>> options)
protected	OptionException(java.util.Collection<? extends OptionSpec<?>> options, java.lang.Throwable cause)
protected	OptionException(java.util.List<java.lang.String> options)

Method Summary

Modifier and Type	Method	Description
private java.lang.String	formattedMessage(java.util.Locale locale)
java.lang.String	getMessage()
(package private) java.lang.String	localizedMessage(java.util.Locale locale)
(package private) abstract java.lang.Object[]	messageArguments()
protected java.lang.String	multipleOptionString()
java.util.List<java.lang.String>	options()	Gives the option being considered when the exception was created.
protected java.lang.String	singleOptionString()
protected java.lang.String	singleOptionString(java.lang.String option)
private java.util.List<java.lang.String>	specsToStrings(java.util.Collection<? extends OptionSpec<?>> options)
private java.lang.String	specToString(OptionSpec<?> option)
(package private) static OptionException	unrecognizedOption(java.lang.String option)

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 Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

options

private final java.util.List<java.lang.String> options

Constructor Detail

OptionException

protected OptionException(java.util.List<java.lang.String> options)

OptionException

protected OptionException(java.util.Collection<? extends OptionSpec<?>> options)

OptionException

protected OptionException(java.util.Collection<? extends OptionSpec<?>> options,
                          java.lang.Throwable cause)

Method Detail

specsToStrings

private java.util.List<java.lang.String> specsToStrings(java.util.Collection<? extends OptionSpec<?>> options)

specToString

private java.lang.String specToString(OptionSpec<?> option)

options

public java.util.List<java.lang.String> options()

Gives the option being considered when the exception was created.

Returns:

the option being considered when the exception was created

singleOptionString

protected final java.lang.String singleOptionString()

singleOptionString

protected final java.lang.String singleOptionString(java.lang.String option)

multipleOptionString

protected final java.lang.String multipleOptionString()

unrecognizedOption

static OptionException unrecognizedOption(java.lang.String option)

getMessage

public final java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

localizedMessage

final java.lang.String localizedMessage(java.util.Locale locale)

formattedMessage

private java.lang.String formattedMessage(java.util.Locale locale)

messageArguments

abstract java.lang.Object[] messageArguments()