Package org.esa.snap.core.util

Interface PropertyMap

All Known Implementing Classes:
AbstractPropertyMap, DefaultPropertyMap, PreferencesPropertyMap
public interface PropertyMap
The PropertyMap class can be used instead of the standard JDK java.util.Properties class.PropertyMap provides a generally more useful interface by adding a couple type conversion methods for a set of most frequently used data types, such as Boolean, Integer, Double, Color and Font.

Additionally the class provides property change support.

Since:
SNAP 2 (revision)

  • Method Details

    • load

      void load(Path file) throws IOException
      Loads key/value pairs from a text file into this property map.
      Parameters:
      file - the text file
      Throws:
      IOException - if an I/O error occurs

    • store

      void store(Path file, String header) throws IOException
      Stores the key/value pairs of this property map into a text file.
      Parameters:
      file - the text file
      header - an optional file header
      Throws:
      IOException - if an I/O error occurs

    • getProperties

      Properties getProperties()
      Returns the Properties instance in which this property map stores its key/value pairs.

    • getPropertyKeys

      Set<String> getPropertyKeys()
      Returns an enumeration of the property keys in this map.

    • getPropertyBool

      boolean getPropertyBool(String key)

    • getPropertyBool

      Boolean getPropertyBool(String key, Boolean defaultValue)

    • setPropertyBool

      void setPropertyBool(String key, Boolean newValue)

    • getPropertyInt

      int getPropertyInt(String key)

    • getPropertyInt

      Integer getPropertyInt(String key, Integer defaultValue)

    • setPropertyInt

      void setPropertyInt(String key, Integer value)

    • getPropertyDouble

      double getPropertyDouble(String key)

    • getPropertyDouble

      Double getPropertyDouble(String key, Double defaultValue)

    • setPropertyDouble

      void setPropertyDouble(String key, Double value)

    • getPropertyString

      String getPropertyString(String key)

    • getPropertyString

      String getPropertyString(String key, String defaultValue)

    • setPropertyString

      void setPropertyString(String key, String value)

    • getPropertyColor

      Color getPropertyColor(String key)

    • getPropertyColor

      Color getPropertyColor(String key, Color defaultValue)

    • setPropertyColor

      void setPropertyColor(String key, Color newValue)

    • getPropertyFont

      Font getPropertyFont(String key)

    • getPropertyFont

      Font getPropertyFont(String key, Font defaultValue)

    • setPropertyFont

      void setPropertyFont(String key, Font font)

    • addPropertyChangeListener

      void addPropertyChangeListener(PropertyChangeListener listener)

    • addPropertyChangeListener

      void addPropertyChangeListener(String key, PropertyChangeListener listener)

    • removePropertyChangeListener

      void removePropertyChangeListener(PropertyChangeListener listener)

    • removePropertyChangeListener

      void removePropertyChangeListener(String key, PropertyChangeListener listener)