CustomOption

All Known Implementing Classes:

AddressFieldOptionsWrappedOption, ArrayElementWrappedOption, ManualViewerCommandWrappedOption, NamespaceWrappedOption
```
public interface CustomOption
```

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String CUSTOM_OPTION_CLASS_NAME_KEY
SaveState key which corresponds to custom option implementation class.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`readState(SaveState saveState)`	Concrete subclass of WrappedOption should read all of its state from the given saveState object.
`java.lang.String`	`toString()`	CustomOption should implement this method to provide a formatted string value of this option value.
`void`	`writeState(SaveState saveState)`	Concrete subclass of WrappedOption should write all of its state to the given saveState object.

- Field Detail
  - CUSTOM_OPTION_CLASS_NAME_KEY
```
static final java.lang.String CUSTOM_OPTION_CLASS_NAME_KEY
```
    SaveState key which corresponds to custom option implementation class. The use of this key/value within the stored state information is reserved for use by the option storage implementation and should be ignored by readState(SaveState) implementation
    
    See Also:
    
    Constant Field Values
- Method Detail
  - readState
```
void readState(SaveState saveState)
```
    Concrete subclass of WrappedOption should read all of its state from the given saveState object.
    
    Parameters:
    
    saveState - container of state information
  - writeState
```
void writeState(SaveState saveState)
```
    Concrete subclass of WrappedOption should write all of its state to the given saveState object.
    
    Parameters:
    
    saveState - container of state information
  - toString
```
java.lang.String toString()
```
    CustomOption should implement this method to provide a formatted string value of this option value. The returned value will be used in support of the Options.getValueAsString(String) and Options.getDefaultValueAsString(String).
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    option value as string