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

Interface PropertyContainer

All Superinterfaces:

PropertyTarget

All Known Subinterfaces:

Allocation, ExpressionTargetContainer, UsageRecord

All Known Implementing Classes:

AccessorMap.ExpressionTargetProxy, AccountingClassification, AccountingLinkManager.PropertyTargetLink, AggregateUsageRecordFactory.AggregateRecord, AllocationFactory.AllocationRecord, CertificatePerson, ChargedAllocationFactory.ChargedAllocationRecord, DataObjectPropertyContainer, DerivedPropertyMap, Person, PropertyMap, PropertyTargetHistoryFactory.HistoryUse, PropertyTuple, UsageRecordFactory.Use

public interface PropertyContainer
extends PropertyTarget

PropertyContainer is a container of property values keyed by PropertyTags. Some PropertyContainers only support a fixed subset of the possible properties in which case get/set operations may throw an InvalidPropertyException. Implementations of this interface should check that the supplied data is allowed by the specified PropertyTag and throw a ClassCastException if this check fails.

Author:

spb

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.
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
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 interface uk.ac.ed.epcc.safe.accounting.properties.PropertyTarget

getProperty

Method Detail

supports

boolean supports(PropertyTag<?> tag)

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

Parameters:

tag -

Returns:

boolean true if property supported

writable

boolean writable(PropertyTag<?> tag)

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

Parameters:

tag -

Returns:

boolean true if property can be written

getProperty

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

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.

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

setProperty

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

Set the specified property

Throws:

InvalidPropertyException

Type Parameters:

T - type of property

Parameters:

key - PropertyTag identifying property

value -

setOptionalProperty

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

Set the specified property if it is supported

Type Parameters:

T - type of property

Parameters:

key - PropertyTag identifying property

value -

getDefinedProperties

java.util.Set<PropertyTag> getDefinedProperties()

Generate a set of all the properties defined in this container

Returns:

Set

setAll

void setAll(PropertyContainer source)

Copy all compatible properties from one container to another;

Parameters:

source - PropertyContainer