Package ghidra.docking.settings

Interface StringSettingsDefinition

All Superinterfaces:
SettingsDefinition
All Known Implementing Classes:
AddressSpaceSettingsDefinition
public interface StringSettingsDefinition extends SettingsDefinition

  • Method Details

    • getValue

      String getValue(Settings settings)
      Gets the value for this SettingsDefinition given a Settings object.
      Parameters:
      settings - the set of Settings values for a particular location or null for default value.
      Returns:
      the value for this settings object given the context.

    • setValue

      void setValue(Settings settings, String value)
      Sets the given value into the given settings object using this settingsDefinition as the key.
      Parameters:
      settings - the settings object to store the value in.
      value - the value to store in the settings object using this settingsDefinition as the key.

    • getValueString

      default String getValueString(Settings settings)
      Description copied from interface: SettingsDefinition
      Get the setting value as a string which corresponds to this definition. A default value string will be returned if a setting has not been stored.
      Specified by:
      getValueString in interface SettingsDefinition
      Parameters:
      settings - settings
      Returns:
      value string or null if not set and default has not specified by this definition

    • hasSameValue

      default boolean hasSameValue(Settings settings1, Settings settings2)
      Description copied from interface: SettingsDefinition
      Check two settings for equality which correspond to this settings definition.
      Specified by:
      hasSameValue in interface SettingsDefinition
      Parameters:
      settings1 - first settings
      settings2 - second settings
      Returns:
      true if the same else false

    • getSuggestedValues

      default String[] getSuggestedValues(Settings settings)
      Get suggested setting values
      Parameters:
      settings - settings object
      Returns:
      suggested settings or null if none or unsupported;

    • supportsSuggestedValues

      default boolean supportsSuggestedValues()
      Determine if this settings definition supports suggested values. See getSuggestedValues(Settings).
      Returns:
      true if suggested values are supported, else false.

    • addPreferredValues

      default boolean addPreferredValues(Object settingsOwner, Set<String> set)
      Add preferred setting values to the specified set as obtained from the specified settingsOwner.
      Parameters:
      settingsOwner - settings owner from which a definition may query preferred values. Supported values are specific to this settings definition. An unsupported settingsOwner will return false.
      set - value set to which values should be added
      Returns:
      true if settingsOwner is supported and set updated, else false.