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

Interface PropertyFinder

All Known Implementing Classes:

ConfigPropertyRegistry, FixedPropertyFinder, MultiFinder, PropertyRegistry, ReferencePropertyRegistry, SetPropertyFinder

public interface PropertyFinder

Interface for locating properties by name

Author:

spb

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.
<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.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
boolean	hasProperty(PropertyTag t) 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.

Method Detail

make

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

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

Throws:

InvalidPropertyException

Parameters:

name -

Returns:

PropertyTag

find

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

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

Parameters:

name -

Returns:

PropertyTag or null

find

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

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.

Type Parameters:

T - Target class

Parameters:

clazz - Class object for target

name - String name of property

Returns:

PropertyTag or null

find

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

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

Parameters:

fil -

name -

Returns:

ProeprtyTag or null

getProperties

java.util.Set<PropertyTag> getProperties()

Get all properties That could be found using this object

Returns:

Set of PropertyTag

hasProperty

boolean hasProperty(PropertyTag t)

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

Parameters:

t -

Returns:

boolean

getProperties

<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

Type Parameters:

T -

Parameters:

clazz -

Returns:

Set of PropertyTag

copy

PropertyFinder copy()

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

Returns:

PropertyFinder