net.dpml.cli

Class OptionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.dpml.cli.OptionException

All Implemented Interfaces:

java.io.Serializable

public class OptionException
extends java.lang.Exception

A problem found while dealing with command line options.

Version:

@PROJECT-VERSION@

Author:

@PUBLISHER-NAME@

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set	HELP_SETTINGS The settings used when displaying the related Option.

Constructor Summary

Constructors

Constructor and Description
OptionException(Option option) Creates a new OptionException.
OptionException(Option option, java.lang.String messageKey) Creates a new OptionException.
OptionException(Option option, java.lang.String messageKey, java.lang.String value) Creates a new OptionException.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getMessage() Return the exception message.
Option	getOption() Gets the Option the exception relates to

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

HELP_SETTINGS

public static final java.util.Set HELP_SETTINGS

The settings used when displaying the related Option.

See Also:

DisplaySetting

Constructor Detail

OptionException

public OptionException(Option option)

Creates a new OptionException.

Parameters:

option - the Option the exception relates to

OptionException

public OptionException(Option option,
               java.lang.String messageKey)

Creates a new OptionException.

Parameters:

option - the Option the exception relates to

messageKey - the id of the message to display

OptionException

public OptionException(Option option,
               java.lang.String messageKey,
               java.lang.String value)

Creates a new OptionException.

Parameters:

option - the Option the exception relates to

messageKey - the id of the message to display

value - a value to display with the message

Method Detail

getOption

public Option getOption()

Gets the Option the exception relates to

Returns:

The related Option

getMessage

public java.lang.String getMessage()

Return the exception message.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the exception message