| java.lang.Object | |
| ↳ | com.pnfsoftware.jeb.core.OptionDefinition |
 Known Direct Subclasses
|
Class Overview
An implementation for an option description.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
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. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.IOptionDefinition
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.ITypedOptionDefinition
| |||||||||||
Public Constructors
public OptionDefinition (String description)
Define a new option with a single text to display.
Parameters
| description | description |
|---|
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 |
public OptionDefinition (String name, String defaultValue, String description)
Define a new option.
Parameters
| name | mandatory name |
|---|
Public Methods
public String getDefaultValue ()
public String getDescription ()
Get the option description.
Returns
- the optional (but strongly recommended) definition description
public String getName ()
Get the definition name. If name is null, then this option is a simple description field.
Returns
- the mandatory definition name
public Object getOptions ()
Optional additional options
Returns
- additional options, depends on type