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()	Get the option default value.
String	getDescription()	Get the option description.
String	getName()	Get the option name.
Object	getOptions()	Get additional option metadata.
ITypedOptionDefinition.Type	getType()	Get the option type inferred from the option shape.

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 - default value

description - option description

Method Details

getDescription

public String getDescription()

Get the option description.

Specified by:

getDescription in interface IOptionDefinition

Returns:

option description

getName

public String getName()

Get the option name.

Specified by:

getName in interface IOptionDefinition

Returns:

option name, or null for a description-only entry

getDefaultValue

public String getDefaultValue()

Get the option default value.

Specified by:

getDefaultValue in interface IOptionDefinition

Returns:

default value, or null if none is defined

getType

public ITypedOptionDefinition.Type getType()

Get the option type inferred from the option shape.

Specified by:

getType in interface ITypedOptionDefinition

Returns:

ITypedOptionDefinition.Type.Description if this definition has no name, otherwise ITypedOptionDefinition.Type.Text

getOptions

public Object getOptions()

Get additional option metadata.

Specified by:

getOptions in interface ITypedOptionDefinition

Returns:

null for plain text options