Method Detail

• getPropertyNames

  Set<String> getPropertyNames()

  Returns the actual property names defined in this set.

  Returns:

  an unmodifiable set of registered property names.

• getProperty

  Object getProperty(String name)

  Returns the value mapped to the specified property name. Returns null if the property is not defined or if it maps to null.

  Parameters:

  name - the property name

  Returns:

  the property value

• getProperty

  String getProperty(String name,
                     String defaultValue)

  Returns the value mapped to the specified property name, or the specified default value if the property is not found or if it cannot be treated as a String.

  Parameters:

  name - the property name

  defaultValue - the default value to use if the property is not found

  Returns:

  the property value

• getProperty

  int getProperty(String name,
                  int defaultValue)

  Returns the value mapped to the specified property name, or the specified default value if the property is not found or if it cannot be treated as a int.

  Parameters:

  name - the property name

  defaultValue - the default value to use if the property is not found

  Returns:

  the property value

• getProperty

  boolean getProperty(String name,
                      boolean defaultValue)

  Returns the value mapped to the specified property name, or the specified default value if the property is not found or if it cannot be treated as a boolean.

  Parameters:

  name - the property name

  defaultValue - the default value to use if the property is not found

  Returns:

  the property value

• getProperty

  float getProperty(String name,
                    float defaultValue)

  Returns the value mapped to the specified property name, or the specified default value if the property is not found or if it cannot be treated as a float.

  Parameters:

  name - the property name

  defaultValue - the default value to use if the property is not found

  Returns:

  the property value

• setProperty

  void setProperty(String name,
                   Object value)

  Associates the specified value with a property name.

  Parameters:

  name - the property name.

  value - the property value (can be null)

• setProperty

  void setProperty(String name,
                   String value)

  Associates the specified value with a property name.

  Parameters:

  name - the property name.

  value - the property value (can be null)

• setProperty

  void setProperty(String name,
                   int value)

  Associates the specified value with a property name.

  Parameters:

  name - the property name.

  value - the property value

• setProperty

  void setProperty(String name,
                   boolean value)

  Associates the specified value with a property name.

  Parameters:

  name - the property name.

  value - the property value

• setProperty

  void setProperty(String name,
                   float value)

  Associates the specified value with a property name.

  Parameters:

  name - the property name.

  value - the property value

• setProperties

  void setProperties(Map<String,?> properties)

  Copies all entries from the specified map into this PropertySet. This method calls setProperty() for each entry of the given map.

  Parameters:

  properties - the properties to copy into this PropertySet.

  Since:

  3.6.0

  See Also:

  setProperty(String, Object)

• setProperties

  void setProperties(PropertySet properties)

  Copies all entries from the specified PropertySet into this PropertySet. This method calls setProperty() for each entry of the given PropertySet.

  Parameters:

  properties - the properties to copy into this PropertySet.

  Since:

  3.6.0

  See Also:

  setProperty(String, Object)

• getProperties

  Map<String,Object> getProperties()

  Returns a map containing a copy of all properties owned by this PropertySet. The map is not backed by this PropertySet, so changes are not reflected in the PropertySet.

  Returns:

  a map containing a copy of all properties owned by this PropertySet.

  Since:

  3.6.0

• loadProperties

  void loadProperties(File file)
               throws IOException

  Load all properties stored in the specified file into this PropertySet. The file must be an XML document which conforms to the specification of the Properties.loadFromXML(java.io.InputStream) method.

  Parameters:

  file - the file from which to read the XML document.

  Throws:

  IOException - if reading from the specified file results in an IOException.

  UnsupportedEncodingException - if the document's encoding declaration can be read and it specifies an encoding that is not supported

  InvalidPropertiesFormatException - Data on input stream does not constitute a valid XML document with the mandated document type.

  Since:

  3.6.0

  See Also:

  Properties.loadFromXML(java.io.InputStream)

• saveProperties

  void saveProperties(File file)
               throws IOException

  Emits an XML document representing all of the properties contained in this PropertySet. The file will be an XML document which conforms to the specification of the Properties.storeToXML(java.io.OutputStream, String) method.

  Note that only properties of following types are stored into the file (other values are ignored):

  • String
  • Boolean
  • Number

  Parameters:

  file - the file where to write an XML document.

  Throws:

  IOException - if writing this property list to the specified file throws an IOException

  Since:

  3.6.0

  See Also:

  Properties.storeToXML(java.io.OutputStream, String)