Package ghidra.framework.options
Interface CustomOption
- All Known Implementing Classes:
AddressFieldOptionsWrappedOption
,ArrayElementWrappedOption
,FileOffsetFieldOptionsWrappedOption
,ManualViewerCommandWrappedOption
,NamespaceWrappedOption
public interface CustomOption
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
SaveState
key which corresponds to custom option implementation class. -
Method Summary
Modifier and TypeMethodDescriptionvoid
readState
(GProperties properties) Concrete subclass of WrappedOption should read all of its state from the given saveState object.toString()
CustomOption should implement this method to provide a formatted string value of this option value.void
writeState
(GProperties properties) Concrete subclass of WrappedOption should write all of its state to the given saveState object.
-
Field Details
-
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 byreadState(SaveState)
implementation- See Also:
-
-
Method Details
-
readState
Concrete subclass of WrappedOption should read all of its state from the given saveState object.- Parameters:
properties
- container of state information
-
writeState
Concrete subclass of WrappedOption should write all of its state to the given saveState object.- Parameters:
properties
- container of state information
-
toString
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 theOptions.getValueAsString(String)
andOptions.getDefaultValueAsString(String)
.
-