DefaultPropertyMap (MathletFactory API Specification)

java.lang.Object
- net.mumie.mathletfactory.util.property.DefaultPropertyMap

All Implemented Interfaces:

PropertyMapIF

Direct Known Subclasses:

CombinedPropertyMap, DisplayProperties, JR3DCanvasLightProperties, JR3DCanvasViewerProperties
```
public class DefaultPropertyMap
extends java.lang.Object
implements PropertyMapIF
```
This class can be used to store arbitrary properties (i.e. values which can be adressed via name keys) in a map. Every property can have its own default value whereas all data is stored in the same map as a java.lang.Object. The internal name of default properties is constructed by the real property name and the suffixe .default. In the case where a property was not set (i.e. no value was stored under the property name), the default value will be retrieved (unless it was set). There are several getter-methods for retrieving values in the correct format from the internal map, where it is almost always necessary to define a default return value if neither an explicit value nor its default value were stored:
- getProperty(String)
- getProperty(String, Object)
- getBooleanProperty(String, boolean)
- getDoubleProperty(String, double)
- #getColorProperty(String, Color)
- #getFontProperty(String, Font)
Default values can only be retrieved explicitly from the map by appending the .default suffixe to the real property name in one of the prior getter-methods.

Values can be stored by one of the following getter-methods, whereas each one returns the old property value which will be overwritten (unless the second method is not used):
- setProperty(String, Object)
- #setProperty(String, Object, boolean)
- setProperty(String, boolean)
- setProperty(String, double)
Note that the last 2 methods don't return a primitive type but their corresponding wrapper classes.
Default values can be stored by appending the .default suffixe to the real property name or by using one of the appropriate setter-methods:
Author:

gronau

Document status:

finished

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String DEFAULT_PROPERTY_SUFFIX
Name suffix for default properties.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_PROPERTY_SUFFIX` Name suffix for default properties.

Constructor Summary

Constructors
Constructor and Description
`DefaultPropertyMap()` Constructs a new empty property map which does not preserve the property order.
`DefaultPropertyMap(boolean preserveOrdering)` Constructs a new empty property map which preserves the property order on activated flag ("FIFO map").
`DefaultPropertyMap(PropertyMapIF map)` Creates a new `DefaultPropertyMap` instance with the same property bindings as the argument and which does not preserve the property order.
`DefaultPropertyMap(PropertyMapIF map, boolean preserveOrdering)` Creates a new `DefaultPropertyMap` instance with the same property bindings as the argument and which preserves the property order on activated flag ("FIFO map").

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Deletes all properties from this map.
`java.lang.Object`	`clone()`
`boolean`	`containsDefaultProperty(java.lang.String name)` Returns if a default property (i.e. a property with a default value) with the given name is contained in the internal map.
`boolean`	`containsProperty(java.lang.String name)` Returns if a property with the given name is contained in this map.
`PropertyMapIF`	`copy()` Returns a new property map instance with the same properties as this map.
`void`	`copyPropertiesFrom(java.util.Map map)`
`void`	`copyPropertiesFrom(PropertyMapIF map)` Copies all properties contained in `map` into this map.
`void`	`copyPropertiesInto(PropertyMapIF map)` Copies all properties contained in this map into `map`.
`boolean`	`equals(java.lang.Object obj)` Returns `true` if the argument is a `PropertyMapIF` and if both have the same size and same keys with the same content.
`boolean`	`getBooleanProperty(java.lang.String name, boolean defaultValue)` Returns the named boolean property from the internal map.
`protected Property`	`getDefaultPropertyImpl(java.lang.String name)`
`double`	`getDoubleProperty(java.lang.String name, double defaultValue)` Returns the named double property from the internal map.
`Property[]`	`getProperties()` Returns an array containing all properties in this map.
`int`	`getPropertiesCount()` Returns the number of properties in this map.
`java.lang.Object`	`getProperty(java.lang.String name)` Returns the named property from the internal map.
`java.lang.Object`	`getProperty(java.lang.String name, java.lang.Object defaultValue)` Returns the named property from the internal map.
`protected Property`	`getPropertyImpl(java.lang.String name)`
`java.lang.String`	`getTextProperty(java.lang.String name)` Returns the named text property from the internal map.
`boolean`	`isEmpty()` Returns whether this map is empty, i.e. contains no properties.
`java.lang.Object`	`removeProperty(java.lang.String name)`
`java.lang.Object`	`setDefaultProperty(Property property)`
`java.lang.Object`	`setDefaultProperty(java.lang.String name, boolean value)` Stores the default boolean value of the named property in the internal map and returns its previous value.
`java.lang.Object`	`setDefaultProperty(java.lang.String name, double value)` Stores the default double value of the named property in the internal map and returns its previous value.
`java.lang.Object`	`setDefaultProperty(java.lang.String name, java.lang.Object value)` Stores the default value of the named property in the internal map and returns its previous value.
`protected Property`	`setDefaultPropertyImpl(Property p)`
`java.lang.Object`	`setProperty(Property property)`
`java.lang.Boolean`	`setProperty(java.lang.String name, boolean value)` Stores the named boolean property in the internal map and returns its previous value.
`java.lang.Double`	`setProperty(java.lang.String name, double value)` Stores the named double property in the internal map and returns its previous value.
`java.lang.Object`	`setProperty(java.lang.String name, java.lang.Object value)` Stores the named property in the internal map and returns its previous value.
`protected Property`	`setPropertyImpl(Property p)`
`java.lang.String`	`toString()` Returns a comma separated list of all stored properties.

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

- Field Detail
  - DEFAULT_PROPERTY_SUFFIX
```
public static final java.lang.String DEFAULT_PROPERTY_SUFFIX
```
    Name suffix for default properties.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - DefaultPropertyMap
```
public DefaultPropertyMap()
```
    Constructs a new empty property map which does not preserve the property order.
  - DefaultPropertyMap
```
public DefaultPropertyMap(boolean preserveOrdering)
```
    Constructs a new empty property map which preserves the property order on activated flag ("FIFO map").
    
    Parameters:
    preserveOrdering - enables a FIFO ordering of the contained properties
  - DefaultPropertyMap
```
public DefaultPropertyMap(PropertyMapIF map)
```
    Creates a new DefaultPropertyMap instance with the same property bindings as the argument and which does not preserve the property order.
    
    Parameters:
    map - an instance of PropertyMapIF or null
  - DefaultPropertyMap
```
public DefaultPropertyMap(PropertyMapIF map,
                  boolean preserveOrdering)
```
    Creates a new DefaultPropertyMap instance with the same property bindings as the argument and which preserves the property order on activated flag ("FIFO map").
    
    Parameters:
    map - an instance of PropertyMapIF or null
    preserveOrdering - enables a FIFO ordering of the contained properties
- Method Detail
  - getProperty
```
public java.lang.Object getProperty(java.lang.String name)
```
    Description copied from interface: PropertyMapIF
    
    Returns the named property from the internal map. When no value is found, the map will be quested for the default value. When no default value is found, null will be returned.
    
    Specified by:
    
    getProperty in interface PropertyMapIF
    
    Parameters:
    name - name of a property
    
    Returns:
    the property's (default) value or null
  - getTextProperty
```
public java.lang.String getTextProperty(java.lang.String name)
```
    Returns the named text property from the internal map. When no value is found, the map will be quested for the default value. When no default value is found, null will be returned.
    
    Parameters:
    name - name of a property
    
    Returns:
    the property's (default) value or null
  - getBooleanProperty
```
public boolean getBooleanProperty(java.lang.String name,
                         boolean defaultValue)
```
    Returns the named boolean property from the internal map. When no value is found, the map will be quested for the default value. When no default value is found, defaultValue will be returned.
    
    Parameters:
    name - name of a property
    defaultValue - default value if neither an explicit nor a default value exist
    
    Returns:
    the property's (default) value or defaultValue
  - getDoubleProperty
```
public double getDoubleProperty(java.lang.String name,
                       double defaultValue)
```
    Returns the named double property from the internal map. When no value is found, the map will be quested for the default value. When no default value is found, defaultValue will be returned.
    
    Parameters:
    name - name of a property
    defaultValue - default value if neither an explicit nor a default value exist
    
    Returns:
    the property's (default) value or defaultValue
  - getProperty
```
public java.lang.Object getProperty(java.lang.String name,
                           java.lang.Object defaultValue)
```
    Returns the named property from the internal map. When no value is found, the map will be quested for the default value. When no default value is found, defaultValue will be returned.
    
    Specified by:
    
    getProperty in interface PropertyMapIF
    
    Parameters:
    name - name of a property
    defaultValue - default value if neither an explicit nor a default value exist; may be null
    
    Returns:
    the property's (default) value or defaultValue
  - getPropertyImpl
```
protected Property getPropertyImpl(java.lang.String name)
```
  - getDefaultPropertyImpl
```
protected Property getDefaultPropertyImpl(java.lang.String name)
```
  - containsProperty
```
public boolean containsProperty(java.lang.String name)
```
    Description copied from interface: PropertyMapIF
    
    Returns if a property with the given name is contained in this map.
    
    Specified by:
    
    containsProperty in interface PropertyMapIF
    
    Parameters:
    name - name of a property
  - containsDefaultProperty
```
public boolean containsDefaultProperty(java.lang.String name)
```
    Description copied from interface: PropertyMapIF
    
    Returns if a default property (i.e. a property with a default value) with the given name is contained in the internal map.
    
    Specified by:
    
    containsDefaultProperty in interface PropertyMapIF
    
    Parameters:
    name - name of a property
  - setProperty
```
public java.lang.Boolean setProperty(java.lang.String name,
                            boolean value)
```
    Stores the named boolean property in the internal map and returns its previous value. Already existing values will be overwritten.
    
    Parameters:
    name - name of a property
    value - property value
    
    Returns:
    the property's previous value as a Boolean or null
  - setProperty
```
public java.lang.Double setProperty(java.lang.String name,
                           double value)
```
    Stores the named double property in the internal map and returns its previous value. Already existing values will be overwritten.
    
    Parameters:
    name - name of a property
    value - property value
    
    Returns:
    the property's previous value as a Double or null
  - setDefaultProperty
```
public java.lang.Object setDefaultProperty(java.lang.String name,
                                  boolean value)
```
    Stores the default boolean value of the named property in the internal map and returns its previous value. Already existing values will be overwritten.
    
    Parameters:
    name - name of a property
    value - property value
    
    Returns:
    the property's previous value as a Boolean or null
  - setDefaultProperty
```
public java.lang.Object setDefaultProperty(java.lang.String name,
                                  double value)
```
    Stores the default double value of the named property in the internal map and returns its previous value. Already existing values will be overwritten.
    
    Parameters:
    name - name of a property
    value - property value
    
    Returns:
    the property's previous value as a Double or null
  - setProperty
```
public java.lang.Object setProperty(java.lang.String name,
                           java.lang.Object value)
```
    Description copied from interface: PropertyMapIF
    
    Stores the named property in the internal map and returns its previous value. If the value is null the possible old property will be removed from the map and returned by this method, or null if none existed. If an old property exists which is read-only, an exception will be thrown
    
    Specified by:
    
    setProperty in interface PropertyMapIF
    
    Parameters:
    name - name of a property
    value - property value; may be null
    
    Returns:
    the old property or null
  - setDefaultProperty
```
public java.lang.Object setDefaultProperty(java.lang.String name,
                                  java.lang.Object value)
```
    Description copied from interface: PropertyMapIF
    
    Stores the default value of the named property in the internal map and returns its previous value. If the value is null the possible old property will be removed from the map and returned by this method, or null if none existed. Already existing values will be overwritten.
    
    Specified by:
    
    setDefaultProperty in interface PropertyMapIF
    
    Parameters:
    name - name of a property
    value - property value; may be null
    
    Returns:
    the property's previous value or null
  - setProperty
```
public java.lang.Object setProperty(Property property)
```
  - setDefaultProperty
```
public java.lang.Object setDefaultProperty(Property property)
```
  - setPropertyImpl
```
protected Property setPropertyImpl(Property p)
```
  - setDefaultPropertyImpl
```
protected Property setDefaultPropertyImpl(Property p)
```
  - removeProperty
```
public java.lang.Object removeProperty(java.lang.String name)
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Description copied from interface: PropertyMapIF
    
    Returns true if the argument is a PropertyMapIF and if both have the same size and same keys with the same content.
    
    Specified by:
    
    equals in interface PropertyMapIF
    
    Overrides:
    
    equals in class java.lang.Object
  - clear
```
public void clear()
```
    Description copied from interface: PropertyMapIF
    
    Deletes all properties from this map.
    
    Specified by:
    
    clear in interface PropertyMapIF
  - copy
```
public PropertyMapIF copy()
```
    Description copied from interface: PropertyMapIF
    
    Returns a new property map instance with the same properties as this map.
    
    Specified by:
    
    copy in interface PropertyMapIF
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - copyPropertiesInto
```
public void copyPropertiesInto(PropertyMapIF map)
```
    Description copied from interface: PropertyMapIF
    
    Copies all properties contained in this map into map.
    
    Specified by:
    
    copyPropertiesInto in interface PropertyMapIF
  - copyPropertiesFrom
```
public void copyPropertiesFrom(PropertyMapIF map)
```
    Description copied from interface: PropertyMapIF
    
    Copies all properties contained in map into this map.
    
    Specified by:
    
    copyPropertiesFrom in interface PropertyMapIF
  - copyPropertiesFrom
```
public void copyPropertiesFrom(java.util.Map map)
```
  - getPropertiesCount
```
public int getPropertiesCount()
```
    Description copied from interface: PropertyMapIF
    
    Returns the number of properties in this map.
    
    Specified by:
    
    getPropertiesCount in interface PropertyMapIF
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: PropertyMapIF
    
    Returns whether this map is empty, i.e. contains no properties.
    
    Specified by:
    
    isEmpty in interface PropertyMapIF
  - getProperties
```
public Property[] getProperties()
```
    Description copied from interface: PropertyMapIF
    
    Returns an array containing all properties in this map.
    
    Specified by:
    
    getProperties in interface PropertyMapIF
  - toString
```
public java.lang.String toString()
```
    Description copied from interface: PropertyMapIF
    
    Returns a comma separated list of all stored properties.
    
    Specified by:
    
    toString in interface PropertyMapIF
    
    Overrides:
    
    toString in class java.lang.Object

Class DefaultPropertyMap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PROPERTY_SUFFIX

Constructor Detail

DefaultPropertyMap

DefaultPropertyMap

DefaultPropertyMap

DefaultPropertyMap

Method Detail

getProperty

getTextProperty

getBooleanProperty

getDoubleProperty

getProperty

getPropertyImpl

getDefaultPropertyImpl

containsProperty

containsDefaultProperty

setProperty

setProperty

setDefaultProperty

setDefaultProperty

setProperty

setDefaultProperty

setProperty

setDefaultProperty

setPropertyImpl

setDefaultPropertyImpl

removeProperty

equals

clear

copy

clone

copyPropertiesInto

copyPropertiesFrom

copyPropertiesFrom

getPropertiesCount

isEmpty

getProperties

toString