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

Class PropertyTuple

java.lang.Object

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

All Implemented Interfaces:

PropertyContainer, PropertyTarget

public class PropertyTuple
extends java.lang.Object
implements PropertyContainer

A PropertyTuple represents a set of PropertyTags and associated values. A PropertyTuple will only equal another if the contents are equivalent.

Author:

spb

Constructor Summary

Constructors

Constructor and Description
PropertyTuple(PropertyMap values)
PropertyTuple(java.util.Set<PropertyTag> use, PropertyContainer values)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
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.
int	hashCode()
java.util.Set<PropertyTag>	propertySet()
void	setAll(PropertyContainer source) Copy all compatible properties from one container to another;
<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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyTuple

public PropertyTuple(PropertyMap values)
              throws InvalidPropertyException

Throws:

InvalidPropertyException

PropertyTuple

public PropertyTuple(java.util.Set<PropertyTag> use,
             PropertyContainer values)
              throws InvalidPropertyException

Throws:

InvalidPropertyException

Method Detail

size

public int size()

propertySet

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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getProperty

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

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

Throws:

InvalidPropertyException

Type Parameters:

T - type of property

Parameters:

key - PropertyTag identifying property

Returns:

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

setOptionalProperty

public <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

setProperty

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

Description copied from interface: PropertyContainer

Set the specified property

Specified by:

setProperty in interface PropertyContainer

Throws:

InvalidPropertyException

Type Parameters:

T - type of property

Parameters:

key - PropertyTag identifying property

supports

public 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

getProperty

public <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.

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

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