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, MissingRequiredOptionException, MultipleArgumentsForOptionException, OptionArgumentConversionException, OptionMissingRequiredArgumentException, UnrecognizedOptionException

public abstract class OptionException
extends java.lang.RuntimeException

Thrown when a problem occurs during option parsing.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OptionException(java.util.Collection<java.lang.String> options)
protected	OptionException(java.util.Collection<java.lang.String> options, OptionSet detected)
protected	OptionException(java.util.Collection<java.lang.String> options, java.lang.Throwable cause)

Method Summary

Modifier and Type	Method and Description
static OptionException	createUnrecognizedOptionException(java.lang.String option, OptionSet detected)
OptionSet	getDetected()
protected java.lang.String	multipleOptionMessage()
java.util.Collection<java.lang.String>	options() Gives the option being considered when the exception was created.
protected java.lang.String	singleOptionMessage()
protected java.lang.String	singleOptionMessage(java.lang.String option)

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 Detail

OptionException

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

OptionException

protected OptionException(java.util.Collection<java.lang.String> options,
                          java.lang.Throwable cause)

OptionException

protected OptionException(java.util.Collection<java.lang.String> options,
                          OptionSet detected)

Method Detail

options

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

Gives the option being considered when the exception was created.

Returns:

the option being considered when the exception was created

singleOptionMessage

protected final java.lang.String singleOptionMessage()

singleOptionMessage

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

multipleOptionMessage

protected final java.lang.String multipleOptionMessage()

createUnrecognizedOptionException

public static OptionException createUnrecognizedOptionException(java.lang.String option,
                                                                OptionSet detected)

getDetected

public OptionSet getDetected()

Returns:

the detected OptionSet