AbstractPropertySet

java.lang.Object
- com.sodius.mdw.core.util.AbstractPropertySet

All Implemented Interfaces:

PropertySet

Direct Known Subclasses:

DefaultPropertySet
```
public abstract class AbstractPropertySet
extends Object
implements PropertySet
```
Skeletal implementation of the PropertySet interface.

Clients may subclass this class.

Since:

3.1.0

Constructor Summary

Constructors
Constructor and Description

AbstractPropertySet()

Constructors
Constructor and Description
`AbstractPropertySet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`getProperties()` Returns a map containing a copy of all properties owned by this PropertySet.
`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`.
`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`.
`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`.
`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`.
`void`	`loadProperties(File file)` Load all properties stored in the specified file into this PropertySet.
`void`	`saveProperties(File file)` Emits an XML document representing all of the properties contained in this PropertySet.
`void`	`setProperties(Map<String,?> properties)` Copies all entries from the specified map into this PropertySet.
`void`	`setProperties(PropertySet properties)` Copies all entries from the specified PropertySet into this PropertySet.
`void`	`setProperty(String name, boolean value)` Associates the specified value with a property name.
`void`	`setProperty(String name, float value)` Associates the specified value with a property name.
`void`	`setProperty(String name, int value)` Associates the specified value with a property name.
`void`	`setProperty(String name, String value)` Associates the specified value with a property name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sodius.mdw.core.util.PropertySet
getProperty, getPropertyNames, setProperty

- Constructor Detail
  - AbstractPropertySet
```
public AbstractPropertySet()
```
- Method Detail
  - getProperty
```
public String getProperty(String name,
                          String defaultValue)
```
    Description copied from interface: PropertySet
    
    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.
    
    Specified by:
    
    getProperty in interface PropertySet
    
    Parameters:
    
    name - the property name
    
    defaultValue - the default value to use if the property is not found
    
    Returns:
    
    the property value
  - getProperty
```
public int getProperty(String name,
                       int defaultValue)
```
    Description copied from interface: PropertySet
    
    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.
    
    Specified by:
    
    getProperty in interface PropertySet
    
    Parameters:
    
    name - the property name
    
    defaultValue - the default value to use if the property is not found
    
    Returns:
    
    the property value
  - getProperty
```
public boolean getProperty(String name,
                           boolean defaultValue)
```
    Description copied from interface: PropertySet
    
    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.
    
    Specified by:
    
    getProperty in interface PropertySet
    
    Parameters:
    
    name - the property name
    
    defaultValue - the default value to use if the property is not found
    
    Returns:
    
    the property value
  - getProperty
```
public float getProperty(String name,
                         float defaultValue)
```
    Description copied from interface: PropertySet
    
    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.
    
    Specified by:
    
    getProperty in interface PropertySet
    
    Parameters:
    
    name - the property name
    
    defaultValue - the default value to use if the property is not found
    
    Returns:
    
    the property value
  - getProperties
```
public Map<String,Object> getProperties()
```
    Description copied from interface: PropertySet
    
    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.
    
    Specified by:
    
    getProperties in interface PropertySet
    
    Returns:
    
    a map containing a copy of all properties owned by this PropertySet.
  - setProperty
```
public void setProperty(String name,
                        String value)
```
    Description copied from interface: PropertySet
    
    Associates the specified value with a property name.
    
    Specified by:
    
    setProperty in interface PropertySet
    
    Parameters:
    
    name - the property name.
    
    value - the property value (can be null)
  - setProperty
```
public void setProperty(String name,
                        int value)
```
    Description copied from interface: PropertySet
    
    Associates the specified value with a property name.
    
    Specified by:
    
    setProperty in interface PropertySet
    
    Parameters:
    
    name - the property name.
    
    value - the property value
  - setProperty
```
public void setProperty(String name,
                        boolean value)
```
    Description copied from interface: PropertySet
    
    Associates the specified value with a property name.
    
    Specified by:
    
    setProperty in interface PropertySet
    
    Parameters:
    
    name - the property name.
    
    value - the property value
  - setProperty
```
public void setProperty(String name,
                        float value)
```
    Description copied from interface: PropertySet
    
    Associates the specified value with a property name.
    
    Specified by:
    
    setProperty in interface PropertySet
    
    Parameters:
    
    name - the property name.
    
    value - the property value
  - setProperties
```
public void setProperties(PropertySet properties)
```
    Description copied from interface: PropertySet
    
    Copies all entries from the specified PropertySet into this PropertySet. This method calls setProperty() for each entry of the given PropertySet.
    
    Specified by:
    
    setProperties in interface PropertySet
    
    Parameters:
    
    properties - the properties to copy into this PropertySet.
    
    See Also:
    
    PropertySet.setProperty(String, Object)
  - setProperties
```
public void setProperties(Map<String,?> properties)
```
    Description copied from interface: PropertySet
    
    Copies all entries from the specified map into this PropertySet. This method calls setProperty() for each entry of the given map.
    
    Specified by:
    
    setProperties in interface PropertySet
    
    Parameters:
    
    properties - the properties to copy into this PropertySet.
    
    See Also:
    
    PropertySet.setProperty(String, Object)
  - loadProperties
```
public void loadProperties(File file)
                    throws IOException
```
    Description copied from interface: PropertySet
    
    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.
    
    Specified by:
    
    loadProperties in interface PropertySet
    
    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.
    
    See Also:
    
    Properties.loadFromXML(java.io.InputStream)
  - saveProperties
```
public void saveProperties(File file)
                    throws IOException
```
    Description copied from interface: PropertySet
    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
    Specified by:
    
    saveProperties in interface PropertySet
    
    Parameters:
    
    file - the file where to write an XML document.
    
    Throws:
    
    IOException - if writing this property list to the specified file throws an IOException
    
    See Also:
    
    Properties.storeToXML(java.io.OutputStream, String)

Class AbstractPropertySet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.sodius.mdw.core.util.PropertySet

Constructor Detail

AbstractPropertySet

Method Detail

getProperty

getProperty

getProperty

getProperty

getProperties

setProperty

setProperty

setProperty

setProperty

setProperties

setProperties

loadProperties

saveProperties