Module net.snaq.jclap

Package snaq.util.jclap

Class OptionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

snaq.util.jclap.OptionException

All Implemented Interfaces:

Serializable

public final class OptionException
extends Exception

Exception for command-line option parsing problems.

Author:

Giles Winstanley

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OptionException.Type	Defines the types of OptionException that exist.

Field Summary

Fields

Modifier and Type	Field	Description
protected static ResourceBundle	BUNDLE	Resources for internationalization.
protected static Locale	LOCALE	Locale for help/error display.

Constructor Summary

Constructors

Constructor	Description
OptionException(OptionException.Type type, String optionName)	Creates a new OptionException instance.
OptionException(OptionException.Type type, String optionName, char flag)	Creates a new OptionException instance.
OptionException(OptionException.Type type, String optionName, String optionValue)	Creates a new OptionException instance.
OptionException(OptionException.Type type, Option option)	Creates a new OptionException instance.
OptionException(OptionException.Type type, Option option, String optionValue)	Creates a new OptionException instance.

Method Summary

Modifier and Type	Method	Description
String	getLocalizedMessage()
String	getMessage()
OptionException.Type	getType()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, 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

LOCALE

protected static final Locale LOCALE

Locale for help/error display.

BUNDLE

protected static final ResourceBundle BUNDLE

Resources for internationalization.

Constructor Detail

OptionException

public OptionException(OptionException.Type type,
                       Option option,
                       String optionValue)

Creates a new OptionException instance.

Parameters:

type - type of OptionException to create (i.e. reason)

option - Option instance for which this exception is being created

optionValue - value of the option for which this exception is being created

OptionException

public OptionException(OptionException.Type type,
                       String optionName,
                       String optionValue)

Creates a new OptionException instance.

Parameters:

type - type of OptionException to create (i.e. reason)

optionName - name of the option for which this exception is being created

optionValue - value of the option for which this exception is being created

OptionException

public OptionException(OptionException.Type type,
                       String optionName,
                       char flag)

Creates a new OptionException instance.

Parameters:

type - type of OptionException to create (i.e. reason)

optionName - name of the option for which this exception is being created

flag - flag character for which this exception is being created

OptionException

public OptionException(OptionException.Type type,
                       Option option)

Creates a new OptionException instance.

Parameters:

type - type of OptionException to create (i.e. reason)

option - Option instance for which this exception is being created

OptionException

public OptionException(OptionException.Type type,
                       String optionName)

Creates a new OptionException instance.

Parameters:

type - type of OptionException to create (i.e. reason)

optionName - name of the option for which this exception is being created

Method Detail

getType

public OptionException.Type getType()

Returns:

exception type

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getLocalizedMessage

public String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable