Package ghidra.framework.options

Interface CustomOption

All Known Implementing Classes:
AddressFieldOptionsWrappedOption, ArrayElementWrappedOption, EolExtraCommentsOption, ManualViewerCommandWrappedOption, NamespaceWrappedOption
public interface CustomOption

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CUSTOM_OPTION_CLASS_NAME_KEY
    Key which corresponds to custom option implementation class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    readState(GProperties properties)
    Read state from the given properties
    String
    toString()
    Subclasses should implement this method to provide a formatted string value of this option value.
    void
    writeState(GProperties properties)
    Write state into the given properties

  • Field Details

    • CUSTOM_OPTION_CLASS_NAME_KEY

      static final String CUSTOM_OPTION_CLASS_NAME_KEY
      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(GProperties) implementation.
      See Also:

  • Method Details

    • readState

      void readState(GProperties properties)
      Read state from the given properties
      Parameters:
      properties - container of state information

    • writeState

      void writeState(GProperties properties)
      Write state into the given properties
      Parameters:
      properties - container of state information

    • toString

      String toString()
      Subclasses 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 Object
      Returns:
      option value as string