Option (fred API)

java.lang.Object
- freenet.config.Option<T>

Direct Known Subclasses:

BooleanOption, IntOption, LongOption, ShortOption, StringArrOption, StringOption
```
public abstract class Option<T>
extends java.lang.Object
```
A config option.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Option.DataType

Nested Classes
Modifier and Type	Class and Description
`static class`	`Option.DataType`

Field Summary

Fields
Modifier and Type	Field and Description
`protected ConfigCallback<T>`	`cb` The configCallback associated to the Option
`protected SubConfig`	`config` The parent SubConfig object
`protected T`	`currentValue`
`protected T`	`defaultValue`
`protected boolean`	`expert` Is this config variable expert-only?
`protected boolean`	`forceWrite` Is this config variable to be written out even if it uses the default value?
`protected java.lang.String`	`longDesc` Long description of value e.g.
`protected java.lang.String`	`name` The option name
`protected java.lang.String`	`shortDesc` Short description of value e.g.
`protected int`	`sortOrder` The sort order

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`forceUpdate()` Call the callback with the current value of the option.
`ConfigCallback<T>`	`getCallback()`
`Option.DataType`	`getDataType()`
`java.lang.String`	`getDataTypeStr()`
`java.lang.String`	`getDefault()`
`java.lang.String`	`getLocalisedLongDesc()` Get the localised long description
`java.lang.String`	`getLocalisedLongDesc(BaseL10n l10n)` Useful for plugins as can pass own BaseL10n in
`java.lang.String`	`getLocalisedShortDesc()` Get the localised short description
`java.lang.String`	`getLocalisedShortDesc(BaseL10n l10n)` Useful for plugins as can pass own BaseL10n in
`HTMLNode`	`getLongDescNode()`
`HTMLNode`	`getLongDescNode(FredPluginConfigurable plugin)` Get the localised long description as an HTMLNode, possibly with translation link
`java.lang.String`	`getName()`
`java.lang.String`	`getShortDesc()` Used in alt="" to label a box with the option name used in the config file.
`HTMLNode`	`getShortDescNode()`
`HTMLNode`	`getShortDescNode(FredPluginConfigurable plugin)` Get the localised short description as an HTMLNode, possibly with translation link
`int`	`getSortOrder()`
`T`	`getValue()` Get the current value.
`java.lang.String`	`getValueDisplayString()` Get the current value of the option as a string suited to end-user display.
`java.lang.String`	`getValueString()` Get the current value of the option as a string.
`boolean`	`isDefault()` Is this option set to the default?
`boolean`	`isExpert()`
`boolean`	`isForcedWrite()`
`protected abstract T`	`parseString(java.lang.String val)`
`protected void`	`set(T val)`
`void`	`setDefault()` Set to the default.
`void`	`setInitialValue(java.lang.String val)` Set to a value from the config file; this is not passed on to the callback, as we expect the client-side initialization to check the value.
`void`	`setValue(java.lang.String val)` Set this option's current value to a string.
`protected java.lang.String`	`toDisplayString(T val)`
`protected abstract java.lang.String`	`toString(T val)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - config
```
protected final SubConfig config
```
    The parent SubConfig object
  - name
```
protected final java.lang.String name
```
    The option name
  - sortOrder
```
protected final int sortOrder
```
    The sort order
  - expert
```
protected final boolean expert
```
    Is this config variable expert-only?
  - forceWrite
```
protected final boolean forceWrite
```
    Is this config variable to be written out even if it uses the default value?
  - shortDesc
```
protected final java.lang.String shortDesc
```
    Short description of value e.g. "FCP port"
  - longDesc
```
protected final java.lang.String longDesc
```
    Long description of value e.g. "The TCP port to listen for FCP connections on"
  - cb
```
protected final ConfigCallback<T> cb
```
    The configCallback associated to the Option
  - defaultValue
```
protected T defaultValue
```
  - currentValue
```
protected T currentValue
```
- Method Detail
  - setValue
```
public final void setValue(java.lang.String val)
                    throws InvalidConfigValueException,
                           NodeNeedRestartException
```
    Set this option's current value to a string. Will call the callback. Does not care whether the value of the option has changed.
    
    Throws:
    
    InvalidConfigValueException
    
    NodeNeedRestartException
  - parseString
```
protected abstract T parseString(java.lang.String val)
                          throws InvalidConfigValueException
```
    Throws:
    
    InvalidConfigValueException
  - toString
```
protected abstract java.lang.String toString(T val)
```
  - toDisplayString
```
protected java.lang.String toDisplayString(T val)
```
  - set
```
protected final void set(T val)
                  throws InvalidConfigValueException,
                         NodeNeedRestartException
```
    Throws:
    
    InvalidConfigValueException
    
    NodeNeedRestartException
  - getValueString
```
public final java.lang.String getValueString()
```
    Get the current value of the option as a string.
  - getValueDisplayString
```
public final java.lang.String getValueDisplayString()
```
    Get the current value of the option as a string suited to end-user display.
  - setInitialValue
```
public final void setInitialValue(java.lang.String val)
                           throws InvalidConfigValueException
```
    Set to a value from the config file; this is not passed on to the callback, as we expect the client-side initialization to check the value. The callback is not valid until the client calls finishedInitialization().
    
    Throws:
    
    InvalidConfigValueException
  - forceUpdate
```
public void forceUpdate()
                 throws InvalidConfigValueException,
                        NodeNeedRestartException
```
    Call the callback with the current value of the option.
    
    Throws:
    
    InvalidConfigValueException
    
    NodeNeedRestartException
  - getName
```
public java.lang.String getName()
```
  - getShortDesc
```
public java.lang.String getShortDesc()
```
    Used in alt="" to label a box with the option name used in the config file. FIXME get rid of said alt=""? Not much use for most users. See caller.
  - isExpert
```
public boolean isExpert()
```
  - isForcedWrite
```
public boolean isForcedWrite()
```
  - getSortOrder
```
public int getSortOrder()
```
  - getDataType
```
public Option.DataType getDataType()
```
  - getDataTypeStr
```
public java.lang.String getDataTypeStr()
```
  - getValue
```
public final T getValue()
```
    Get the current value. This is the value in use if we have finished initialization, otherwise it is the value set at startup (possibly the default).
  - isDefault
```
public boolean isDefault()
```
    Is this option set to the default?
  - setDefault
```
public final void setDefault()
```
    Set to the default. Don't use after completed initialization, as this does not call the callback.
  - getDefault
```
public final java.lang.String getDefault()
```
  - getCallback
```
public final ConfigCallback<T> getCallback()
```
  - getLocalisedShortDesc
```
public java.lang.String getLocalisedShortDesc(BaseL10n l10n)
```
    Useful for plugins as can pass own BaseL10n in
  - getLocalisedShortDesc
```
public java.lang.String getLocalisedShortDesc()
```
    Get the localised short description
  - getLocalisedLongDesc
```
public java.lang.String getLocalisedLongDesc(BaseL10n l10n)
```
    Useful for plugins as can pass own BaseL10n in
  - getLocalisedLongDesc
```
public java.lang.String getLocalisedLongDesc()
```
    Get the localised long description
  - getShortDescNode
```
public HTMLNode getShortDescNode(FredPluginConfigurable plugin)
```
    Get the localised short description as an HTMLNode, possibly with translation link
  - getShortDescNode
```
public HTMLNode getShortDescNode()
```
  - getLongDescNode
```
public HTMLNode getLongDescNode(FredPluginConfigurable plugin)
```
    Get the localised long description as an HTMLNode, possibly with translation link
  - getLongDescNode
```
public HTMLNode getLongDescNode()
```

Class Option<T>

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

config

name

sortOrder

expert

forceWrite

shortDesc

longDesc

cb

defaultValue

currentValue

Method Detail

setValue

parseString

toString

toDisplayString

set

getValueString

getValueDisplayString

setInitialValue

forceUpdate

getName

getShortDesc

isExpert

isForcedWrite

getSortOrder

getDataType

getDataTypeStr

getValue

isDefault

setDefault

getDefault

getCallback

getLocalisedShortDesc

getLocalisedShortDesc

getLocalisedLongDesc

getLocalisedLongDesc

getShortDescNode

getShortDescNode

getLongDescNode

getLongDescNode