Package com.pnfsoftware.jeb.core

Class OptionDefinition

java.lang.Object

com.pnfsoftware.jeb.core.OptionDefinition

All Implemented Interfaces:

IOptionDefinition, ITypedOptionDefinition

Direct Known Subclasses:

BooleanOptionDefinition, ListOptionDefinition

public class OptionDefinition
extends Object
implements ITypedOptionDefinition

An implementation for an option description.

Nested Class Summary

Nested classes/interfaces inherited from interface com.pnfsoftware.jeb.core.ITypedOptionDefinition

ITypedOptionDefinition.Type

Constructor Summary

Constructors

Constructor	Description
OptionDefinition(String description)	Define a new option with a single text to display.
OptionDefinition(String name, String description)	Define a new option.
OptionDefinition(String name, String defaultValue, String description)	Define a new option.

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()
String	getDescription()	Get the option description.
String	getName()	Get the definition name.
Object	getOptions()	Optional additional options
ITypedOptionDefinition.Type	getType()	Retrieve the type of the option

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OptionDefinition

public OptionDefinition(String description)

Define a new option with a single text to display.

Parameters:

description - description

OptionDefinition

public OptionDefinition(String name,
 String description)

Define a new option.

Parameters:

name - non-empty name. If null, will display a single text line (prefer OptionDefinition(String) in this case).

description - optional description

OptionDefinition

public OptionDefinition(String name,
 String defaultValue,
 String description)

Define a new option.

Parameters:

name - mandatory name

defaultValue -

description -

Method Details

getDescription

public String getDescription()

Description copied from interface: IOptionDefinition

Get the option description.

Specified by:

getDescription in interface IOptionDefinition

Returns:

the optional (but strongly recommended) definition description

getName

public String getName()

Description copied from interface: IOptionDefinition

Get the definition name. If name is null, then this option is a simple description field.

Specified by:

getName in interface IOptionDefinition

Returns:

the mandatory definition name

getDefaultValue

public String getDefaultValue()

Specified by:

getDefaultValue in interface IOptionDefinition

Returns:

getType

public ITypedOptionDefinition.Type getType()

Description copied from interface: ITypedOptionDefinition

Retrieve the type of the option

Specified by:

getType in interface ITypedOptionDefinition

Returns:

the type

getOptions

public Object getOptions()

Description copied from interface: ITypedOptionDefinition

Optional additional options

Specified by:

getOptions in interface ITypedOptionDefinition

Returns:

additional options, depends on type