com.portal.common

Class CommandLineParser.OptionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.portal.common.CommandLineParser.OptionException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CommandLineParser.NoSuchOptionException, CommandLineParser.OptionDataException, CommandLineParser.ValueOutOfBoundsException

Enclosing class:

CommandLineParser

public abstract class CommandLineParser.OptionException
extends Exception

Signals that an exception occurred while doing an operation that involved an option (lookup of the option, data retrieval, etc.)

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OptionException(String msg) An error occurred while doing an operation that involved an option (lookup of the option, data retrieval, etc.)
protected	OptionException(String option, String msg) An error occurred while doing an operation that involved an option (lookup of the option, data retrieval, etc.)

Method Summary

Modifier and Type	Method and Description
String	getOption() Get the name of the option that caused the exception to be thrown.

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(String msg)

An error occurred while doing an operation that involved an option (lookup of the option, data retrieval, etc.)

Parameters:

msg - A non-localized string description of the error

OptionException

protected OptionException(String option,
                          String msg)

An error occurred while doing an operation that involved an option (lookup of the option, data retrieval, etc.)

Parameters:

option - The option that was involved in operation that failed

msg - A non-localized string description of the error

Method Detail

getOption

public String getOption()

Get the name of the option that caused the exception to be thrown.

Returns:

the name of the option that caused the exception to be thrown.