uk.ac.ed.epcc.safe.accounting.properties

Class PropertyMap

java.lang.Object

uk.ac.ed.epcc.safe.accounting.properties.PropertyMap

All Implemented Interfaces:

PropertyContainer, PropertyTarget

Direct Known Subclasses:

DerivedPropertyMap

public class PropertyMap
extends java.lang.Object
implements PropertyContainer

A map of Property values keyed by PropertyTag This class provides a memory resident implementation of PropertyContainer that is capable of storing any property. PropertyMap will therefore not throw InvalidPropertyException from the set methods.

Author:

spb

Constructor Summary

Constructors

Constructor and Description
PropertyMap()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<PropertyTag>	getDefinedProperties() Generate a set of all the properties defined in this container
<T> T	getProperty(PropertyTag<T> key) Get the specified property from the container.
<T> T	getProperty(PropertyTag<T> tag, T def) Get property with default.
java.util.Set<PropertyTag>	propertySet()
void	setAll(PropertyContainer source) Copy all compatible properties from one container to another;
int	setContainer(PropertyContainer record) Set all properties that can be written to a container
<T> void	setOptionalProperty(PropertyTag<? super T> key, T value) Set the specified property if it is supported
<T> void	setProperty(PropertyTag<? super T> key, T value) Set the specified property
int	size()
boolean	supports(PropertyTag<?> tag) Is the specified property supported by the container.
boolean	writable(PropertyTag<?> tag) Is the specified property supported for write.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyMap

public PropertyMap()

Method Detail

getProperty

public <T> T getProperty(PropertyTag<T> key)

Description copied from interface: PropertyContainer

Get the specified property from the container. THe InvalidPropertyException should only be thrown if the supports method would have returned false for the requested property.

Specified by:

getProperty in interface PropertyContainer

Type Parameters:

T - type of property

Parameters:

key - PropertyTag identifying property

Returns:

value current value of property (may be null if not set).

setProperty

public final <T> void setProperty(PropertyTag<? super T> key,
                   T value)

Description copied from interface: PropertyContainer

Set the specified property

Specified by:

setProperty in interface PropertyContainer

Type Parameters:

T - type of property

Parameters:

key - PropertyTag identifying property

setOptionalProperty

public final <T> void setOptionalProperty(PropertyTag<? super T> key,
                           T value)

Description copied from interface: PropertyContainer

Set the specified property if it is supported

Specified by:

setOptionalProperty in interface PropertyContainer

Type Parameters:

T - type of property

Parameters:

key - PropertyTag identifying property

setContainer

public int setContainer(PropertyContainer record)

Set all properties that can be written to a container

Parameters:

record -

Returns:

number of properties set

getProperty

public final <T> T getProperty(PropertyTag<T> tag,
                T def)

Description copied from interface: PropertyTarget

Get property with default. If the property is not supported by the container of if no value has been set then the default value is returned.

Specified by:

getProperty in interface PropertyTarget

Type Parameters:

T - Type of property

Parameters:

tag - PropertTag identifying property

def - default value

Returns:

property value or default.

supports

public final boolean supports(PropertyTag<?> tag)

Description copied from interface: PropertyContainer

Is the specified property supported by the container. If the container is unconstrained this always returns true

Specified by:

supports in interface PropertyContainer

Returns:

boolean true if property supported

writable

public boolean writable(PropertyTag<?> tag)

Description copied from interface: PropertyContainer

Is the specified property supported for write. If the container is unconstrained this always returns true

Specified by:

writable in interface PropertyContainer

Returns:

boolean true if property can be written

propertySet

public java.util.Set<PropertyTag> propertySet()

size

public int size()

getDefinedProperties

public java.util.Set<PropertyTag> getDefinedProperties()

Description copied from interface: PropertyContainer

Generate a set of all the properties defined in this container

Specified by:

getDefinedProperties in interface PropertyContainer

Returns:

Set

setAll

public void setAll(PropertyContainer source)

Description copied from interface: PropertyContainer

Copy all compatible properties from one container to another;

Specified by:

setAll in interface PropertyContainer

Parameters:

source - PropertyContainer