Package org.openstreetmap.josm.spi.preferences

Interface IPreferences

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void addKeyPreferenceChangeListener​(java.lang.String key, PreferenceChangedListener listener)
      Adds a listener that only listens to changes in one preference
      void addPreferenceChangeListener​(PreferenceChangedListener listener)
      Adds a new preferences listener.
      void addSensitive​(CredentialsAgent caller, java.lang.String key)
      Add sensitive keys
      default java.lang.String get​(java.lang.String key)
      Get settings value for a certain key.
      java.lang.String get​(java.lang.String key, java.lang.String def)
      Get settings value for a certain key and provide a default value.
      default boolean getBoolean​(java.lang.String key)
      Gets a boolean preference
      boolean getBoolean​(java.lang.String key, boolean def)
      Gets a boolean preference
      double getDouble​(java.lang.String key, double def)
      Gets a double preference
      int getInt​(java.lang.String key, int def)
      Gets an integer preference
      java.util.Set<java.lang.String> getKeySet()
      Get the set of all keys that are mapped to a value in this preferences.
      default java.util.List<java.lang.String> getList​(java.lang.String key)
      Get a list of values for a certain key
      java.util.List<java.lang.String> getList​(java.lang.String key, java.util.List<java.lang.String> def)
      Get a list of values for a certain key
      default java.util.List<java.util.List<java.lang.String>> getListOfLists​(java.lang.String key)
      Get an array of values (list of lists) for a certain key
      java.util.List<java.util.List<java.lang.String>> getListOfLists​(java.lang.String key, java.util.List<java.util.List<java.lang.String>> def)
      Get an array of values (list of lists) for a certain key
      default java.util.List<java.util.Map<java.lang.String,​java.lang.String>> getListOfMaps​(java.lang.String key)
      Gets a list of key/value maps.
      java.util.List<java.util.Map<java.lang.String,​java.lang.String>> getListOfMaps​(java.lang.String key, java.util.List<java.util.Map<java.lang.String,​java.lang.String>> def)
      Gets a list of key/value maps.
      long getLong​(java.lang.String key, long def)
      Gets a long preference
      java.util.Collection<java.lang.String> getSensitive()
      Get sensitive keys
      boolean put​(java.lang.String key, java.lang.String value)
      Set a value for a certain setting.
      boolean putBoolean​(java.lang.String key, boolean value)
      Set a boolean value for a certain setting.
      boolean putDouble​(java.lang.String key, double value)
      Set a boolean value for a certain setting.
      boolean putInt​(java.lang.String key, int value)
      Set an integer value for a certain setting.
      boolean putList​(java.lang.String key, java.util.List<java.lang.String> value)
      Set a list of values for a certain key.
      boolean putListOfLists​(java.lang.String key, java.util.List<java.util.List<java.lang.String>> value)
      Set an array of values (list of lists) for a certain key.
      boolean putListOfMaps​(java.lang.String key, java.util.List<java.util.Map<java.lang.String,​java.lang.String>> value)
      Set an a list of key/value maps.
      boolean putLong​(java.lang.String key, long value)
      Set a long value for a certain setting.
      void removeKeyPreferenceChangeListener​(java.lang.String key, PreferenceChangedListener listener)
      Removes a listener that only listens to changes in one preference
      void removePreferenceChangeListener​(PreferenceChangedListener listener)
      Removes a preferences listener.
      void removeSensitive​(java.lang.String key)
      Remove sensitive keys.

    • Method Detail

      • addKeyPreferenceChangeListener

        void addKeyPreferenceChangeListener​(java.lang.String key,
                                    PreferenceChangedListener listener)
        Adds a listener that only listens to changes in one preference
        Parameters:
        key - The preference key to listen to
        listener - The listener to add.

      • get

        java.lang.String get​(java.lang.String key,
                     java.lang.String def)
        Get settings value for a certain key and provide a default value.
        Parameters:
        key - the identifier for the setting
        def - the default value. For each call of get() with a given key, the default value must be the same. def may be null.
        Returns:
        the corresponding value if the property has been set before, def otherwise

      • get

        default java.lang.String get​(java.lang.String key)
        Get settings value for a certain key.
        Parameters:
        key - the identifier for the setting
        Returns:
        "" if there is nothing set for the preference key, the corresponding value otherwise. The result is not null.

      • put

        boolean put​(java.lang.String key,
            java.lang.String value)
        Set a value for a certain setting.
        Parameters:
        key - the unique identifier for the setting
        value - the value of the setting. Can be null or "" which both removes the key-value entry.
        Returns:
        true, if something has changed (i.e. value is different than before)

      • getBoolean

        boolean getBoolean​(java.lang.String key,
                   boolean def)
        Gets a boolean preference
        Parameters:
        key - The preference key
        def - The default value to use
        Returns:
        The boolean, false if it could not be parsed, the default value if it is unset

      • getBoolean

        default boolean getBoolean​(java.lang.String key)
        Gets a boolean preference
        Parameters:
        key - The preference key
        Returns:
        The boolean or false if it could not be parsed

      • putBoolean

        boolean putBoolean​(java.lang.String key,
                   boolean value)
        Set a boolean value for a certain setting.
        Parameters:
        key - the unique identifier for the setting
        value - The new value
        Returns:
        true, if something has changed (i.e. value is different than before)
        Since:
        12840

      • getInt

        int getInt​(java.lang.String key,
           int def)
        Gets an integer preference
        Parameters:
        key - The preference key
        def - The default value to use
        Returns:
        The integer
        Since:
        12840

      • putInt

        boolean putInt​(java.lang.String key,
               int value)
        Set an integer value for a certain setting.
        Parameters:
        key - the unique identifier for the setting
        value - The new value
        Returns:
        true, if something has changed (i.e. value is different than before)
        Since:
        12840

      • getLong

        long getLong​(java.lang.String key,
             long def)
        Gets a long preference
        Parameters:
        key - The preference key
        def - The default value to use
        Returns:
        The long value or the default value if it could not be parsed

      • putLong

        boolean putLong​(java.lang.String key,
                long value)
        Set a long value for a certain setting.
        Parameters:
        key - the unique identifier for the setting
        value - The new value
        Returns:
        true, if something has changed (i.e. value is different than before)

      • getDouble

        double getDouble​(java.lang.String key,
                 double def)
        Gets a double preference
        Parameters:
        key - The preference key
        def - The default value to use
        Returns:
        The double value or the default value if it could not be parsed

      • putDouble

        boolean putDouble​(java.lang.String key,
                  double value)
        Set a boolean value for a certain setting.
        Parameters:
        key - the unique identifier for the setting
        value - The new value
        Returns:
        true, if something has changed (i.e. value is different than before)
        Since:
        12840

      • getList

        java.util.List<java.lang.String> getList​(java.lang.String key,
                                         java.util.List<java.lang.String> def)
        Get a list of values for a certain key
        Parameters:
        key - the identifier for the setting
        def - the default value.
        Returns:
        the corresponding value if the property has been set before, def otherwise
        Since:
        12840

      • getList

        default java.util.List<java.lang.String> getList​(java.lang.String key)
        Get a list of values for a certain key
        Parameters:
        key - the identifier for the setting
        Returns:
        the corresponding value if the property has been set before, an empty list otherwise.
        Since:
        12840

      • putList

        boolean putList​(java.lang.String key,
                java.util.List<java.lang.String> value)
        Set a list of values for a certain key.
        Parameters:
        key - the identifier for the setting
        value - The new value
        Returns:
        true, if something has changed (i.e. value is different than before)
        Since:
        12840

      • getListOfLists

        java.util.List<java.util.List<java.lang.String>> getListOfLists​(java.lang.String key,
                                                                java.util.List<java.util.List<java.lang.String>> def)
        Get an array of values (list of lists) for a certain key
        Parameters:
        key - the identifier for the setting
        def - the default value.
        Returns:
        the corresponding value if the property has been set before, def otherwise
        Since:
        12840

      • getListOfLists

        default java.util.List<java.util.List<java.lang.String>> getListOfLists​(java.lang.String key)
        Get an array of values (list of lists) for a certain key
        Parameters:
        key - the identifier for the setting
        Returns:
        the corresponding value if the property has been set before, an empty list otherwise
        Since:
        12840

      • putListOfLists

        boolean putListOfLists​(java.lang.String key,
                       java.util.List<java.util.List<java.lang.String>> value)
        Set an array of values (list of lists) for a certain key.
        Parameters:
        key - the identifier for the setting
        value - the new value
        Returns:
        true, if something has changed (i.e. value is different than before)
        Since:
        12840

      • getListOfMaps

        java.util.List<java.util.Map<java.lang.String,​java.lang.String>> getListOfMaps​(java.lang.String key,
                                                                                     java.util.List<java.util.Map<java.lang.String,​java.lang.String>> def)
        Gets a list of key/value maps.
        Parameters:
        key - the key to search at
        def - the default value to use
        Returns:
        the corresponding value if the property has been set before, def otherwise
        Since:
        12840

      • getListOfMaps

        default java.util.List<java.util.Map<java.lang.String,​java.lang.String>> getListOfMaps​(java.lang.String key)
        Gets a list of key/value maps.
        Parameters:
        key - the key to search at
        Returns:
        the corresponding value if the property has been set before, an empty list otherwise
        Since:
        12840

      • putListOfMaps

        boolean putListOfMaps​(java.lang.String key,
                      java.util.List<java.util.Map<java.lang.String,​java.lang.String>> value)
        Set an a list of key/value maps.
        Parameters:
        key - the key to store the list in
        value - a list of key/value maps
        Returns:
        true if the value was changed
        Since:
        12840

      • getKeySet

        java.util.Set<java.lang.String> getKeySet()
        Get the set of all keys that are mapped to a value in this preferences.
        Returns:
        the set of all keys

      • addSensitive

        void addSensitive​(CredentialsAgent caller,
                  java.lang.String key)
        Add sensitive keys
        Parameters:
        caller - The calling agent
        key - The key that may contain sensitive information
        Since:
        18650

      • getSensitive

        java.util.Collection<java.lang.String> getSensitive()
        Get sensitive keys
        Returns:
        The sensitive keys
        Since:
        18650

      • removeSensitive

        void removeSensitive​(java.lang.String key)
        Remove sensitive keys. This removes the key from the sensitive list and removes the stored preference value.
        Parameters:
        key - The key to remove
        Since:
        18650