org.kohsuke.args4j

Class UndefinedOptionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.kohsuke.args4j.CmdLineException

org.kohsuke.args4j.UndefinedOptionException

All Implemented Interfaces:

java.io.Serializable

public class UndefinedOptionException
extends CmdLineException

Signals that an option is not defined.

The Throwable.getMessage() method returns a human-readable localized description of the error message.

Author:

Kohsuke Kawaguchi (kk@kohsuke.org)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UndefinedOptionException(java.lang.String optionName)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getOptionName() Returns the name of the option that caused a problem.

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

UndefinedOptionException

public UndefinedOptionException(java.lang.String optionName)

Method Detail

getOptionName

public java.lang.String getOptionName()

Returns the name of the option that caused a problem.

Returns:

For example, if the command line is "-n" where the "-n" option is not recognized, then this method returns "-n".