Package ghidra.docking.settings

Interface Settings

  • All Known Subinterfaces:
    Data
    All Known Implementing Classes:
    DataStub, PseudoData, SettingsImpl
    public interface Settings
    Settings objects store name-value pairs. Each SettingsDefinition defines one or more names to use to store values in settings objects. Exactly what type of value and how to interpret the value is done by the SettingsDefinition object.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearAllSettings()
      Removes all name-value pairs from this settings object
      void clearSetting​(java.lang.String name)
      Removes any value associated with the given name
      byte[] getByteArray​(java.lang.String name)
      Gets the byte[] value associated with the given name
      Settings getDefaultSettings()
      Returns the underlying default settings for these settings or null if there are none
      java.lang.Long getLong​(java.lang.String name)
      Gets the Long value associated with the given name
      java.lang.String[] getNames()
      Get this list of keys that currently have values associated with them
      java.lang.String getString​(java.lang.String name)
      Gets the String value associated with the given name
      java.lang.Object getValue​(java.lang.String name)
      Gets the object associated with the given name
      boolean isEmpty()
      Returns true if there are no key-value pairs stored in this settings object
      void setByteArray​(java.lang.String name, byte[] value)
      Associates the given byte[] with the name
      void setLong​(java.lang.String name, long value)
      Associates the given long value with the name
      void setString​(java.lang.String name, java.lang.String value)
      Associates the given String value with the name
      void setValue​(java.lang.String name, java.lang.Object value)
      Associates the given object with the name

    • Method Detail

      • getLong

        java.lang.Long getLong​(java.lang.String name)
        Gets the Long value associated with the given name
        Parameters:
        name - the key used to retrieve a value
        Returns:
        the Long value for a key

      • getString

        java.lang.String getString​(java.lang.String name)
        Gets the String value associated with the given name
        Parameters:
        name - the key used to retrieve a value
        Returns:
        the String value for a key

      • getByteArray

        byte[] getByteArray​(java.lang.String name)
        Gets the byte[] value associated with the given name
        Parameters:
        name - the key used to retrieve a value
        Returns:
        the byte[] value for a key

      • getValue

        java.lang.Object getValue​(java.lang.String name)
        Gets the object associated with the given name
        Parameters:
        name - the key used to retrieve a value
        Returns:
        the object associated with a given key

      • setLong

        void setLong​(java.lang.String name,
             long value)
        Associates the given long value with the name
        Parameters:
        name - the key
        value - the value associated with the key

      • setString

        void setString​(java.lang.String name,
               java.lang.String value)
        Associates the given String value with the name
        Parameters:
        name - the key
        value - the value associated with the key

      • setByteArray

        void setByteArray​(java.lang.String name,
                  byte[] value)
        Associates the given byte[] with the name
        Parameters:
        name - the key
        value - the value associated with the key

      • setValue

        void setValue​(java.lang.String name,
              java.lang.Object value)
        Associates the given object with the name
        Parameters:
        name - the key
        value - the value to associate with the key

      • clearSetting

        void clearSetting​(java.lang.String name)
        Removes any value associated with the given name
        Parameters:
        name - the key to remove any association

      • clearAllSettings

        void clearAllSettings()
        Removes all name-value pairs from this settings object

      • getNames

        java.lang.String[] getNames()
        Get this list of keys that currently have values associated with them
        Returns:
        an array of string keys.

      • isEmpty

        boolean isEmpty()
        Returns true if there are no key-value pairs stored in this settings object

      • getDefaultSettings

        Settings getDefaultSettings()
        Returns the underlying default settings for these settings or null if there are none