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

Class FixedPropertyFinder

java.lang.Object

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

All Implemented Interfaces:

PropertyFinder

Direct Known Subclasses:

PropertyRegistry

public class FixedPropertyFinder
extends java.lang.Object
implements PropertyFinder

A PropertyFinder containing a fixed set of properties from a single namespace Typically used to implement a PropertyRegistry

Author:

spb

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
static java.lang.String	PROPERTY_FINDER_NAME_REGEXP
static java.lang.String	PROPERTY_FINDER_PREFIX_REGEXP
static java.lang.String	PROPERTY_FINDER_SEPERATOR
protected java.util.Map<java.lang.String,PropertyTag>	registry

Constructor Summary

Constructors

Constructor and Description
FixedPropertyFinder(java.lang.String name, java.lang.String description, java.util.Map<java.lang.String,PropertyTag> map)

Method Summary

Methods

Modifier and Type	Method and Description
PropertyFinder	copy() return a new PropertyFinder that represents a copy of the current state of this object.
boolean	equals(java.lang.Object obj)
<T> PropertyTag<? extends T>	find(java.lang.Class<T> clazz, java.lang.String name) Locate a registered property by name and class of result.
PropertyTag<?>	find(java.lang.String name) Locate a registered property by name.
PropertyTag<?>	find(TagFilter fil, java.lang.String name) Locate a registered property by name and additional filter.
java.lang.String	getDescription()
protected java.lang.String	getPrefix()
java.util.Set<PropertyTag>	getProperties() Get all properties That could be found using this object
<T> java.util.Set<PropertyTag<? extends T>>	getProperties(java.lang.Class<T> clazz) Get all properties where the property can be assigned to class T
int	hashCode()
boolean	hasProperty(PropertyTag tag) is the specified property in the set of properties that can be found by this object.
PropertyTag<?>	make(java.lang.String name) Locate a registered property by name.
int	size()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_FINDER_NAME_REGEXP

public static final java.lang.String PROPERTY_FINDER_NAME_REGEXP

See Also:

Constant Field Values

PROPERTY_FINDER_SEPERATOR

public static final java.lang.String PROPERTY_FINDER_SEPERATOR

See Also:

Constant Field Values

PROPERTY_FINDER_PREFIX_REGEXP

public static final java.lang.String PROPERTY_FINDER_PREFIX_REGEXP

See Also:

Constant Field Values

registry

protected final java.util.Map<java.lang.String,PropertyTag> registry

name

protected final java.lang.String name

Constructor Detail

FixedPropertyFinder

public FixedPropertyFinder(java.lang.String name,
                   java.lang.String description,
                   java.util.Map<java.lang.String,PropertyTag> map)

Method Detail

copy

public PropertyFinder copy()

Description copied from interface: PropertyFinder

return a new PropertyFinder that represents a copy of the current state of this object.

Specified by:

copy in interface PropertyFinder

Returns:

PropertyFinder

getDescription

public java.lang.String getDescription()

find

public PropertyTag<?> find(java.lang.String name)

Description copied from interface: PropertyFinder

Locate a registered property by name. Note that this is only able to find a property once the class where the property is defined has been loaded

Specified by:

find in interface PropertyFinder

Returns:

PropertyTag or null

find

public <T> PropertyTag<? extends T> find(java.lang.Class<T> clazz,
                                java.lang.String name)

Description copied from interface: PropertyFinder

Locate a registered property by name and class of result. This method will only return a PropertyTag if its property can be assigned to class T This is primarily intended to distinguish between tags with the same unqualified name.

Specified by:

find in interface PropertyFinder

Type Parameters:

T - Target class

Parameters:

clazz - Class object for target

name - String name of property

Returns:

PropertyTag or null

find

public PropertyTag<?> find(TagFilter fil,
                  java.lang.String name)

Description copied from interface: PropertyFinder

Locate a registered property by name and additional filter. This method will only return a PropertyTag if the TagFilter accepts the result.

Specified by:

find in interface PropertyFinder

Returns:

ProeprtyTag or null

getProperties

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

Description copied from interface: PropertyFinder

Get all properties That could be found using this object

Specified by:

getProperties in interface PropertyFinder

Returns:

Set of PropertyTag

hasProperty

public boolean hasProperty(PropertyTag tag)

Description copied from interface: PropertyFinder

is the specified property in the set of properties that can be found by this object.

Specified by:

hasProperty in interface PropertyFinder

Returns:

boolean

getProperties

public <T> java.util.Set<PropertyTag<? extends T>> getProperties(java.lang.Class<T> clazz)

Description copied from interface: PropertyFinder

Get all properties where the property can be assigned to class T

Specified by:

getProperties in interface PropertyFinder

Returns:

Set of PropertyTag

make

public PropertyTag<?> make(java.lang.String name)
                    throws InvalidPropertyException

Description copied from interface: PropertyFinder

Locate a registered property by name. The property is required to exist and an InvalidPropertyException will be thrown if it does not. Note that this is only able to find a property once the class where the property is defined has been loaded

Specified by:

make in interface PropertyFinder

Throws:

InvalidPropertyException

Returns:

PropertyTag

size

public int size()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getPrefix

protected java.lang.String getPrefix()