Package org.apache.tamaya.spi

Class FilterContext

java.lang.Object

org.apache.tamaya.spi.FilterContext

public class FilterContext
extends Object

A filter configurationContext containing all the required values for implementing filtering.

See Also:

PropertyFilter

Constructor Summary

Constructors

Constructor	Description
FilterContext(List<PropertyValue> values, ConfigurationContext configurationContext)	Creates a new FilterContext, for filtering of a single createValue access using Configuration.getProperties().
FilterContext(PropertyValue value, Map<String,PropertyValue> configEntries, ConfigurationContext configurationContext)	Creates a new FilterContext, for filtering of a multi createValue access using Configuration.getProperties().
FilterContext(PropertyValue value, ConfigurationContext configurationContext)	Creates a new FilterContext, for filtering of a single createValue access using Configuration.getProperties().

Method Summary

Modifier and Type	Method	Description
List<PropertyValue>	getAllValues()	Get the property createValue under evaluation.
Map<String,PropertyValue>	getConfigEntries()	This mapProperties contains the following keys: the original createValue before any filters were applied on it. all values starting with an _<key>., for example a.createValue may have a mapProperties setCurrent with a.createValue (oringinal createValue), _a.createValue.origin, _a.createValue.type, etc.
ConfigurationContext	getConfigurationContext()	Get the current configurationContext.
PropertyValue	getProperty()	Get the property createValue under evaluation.
boolean	isSinglePropertyScoped()	Method that determines if filtering is done for a single property accessed, or as part of call to getProperties().
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterContext

public FilterContext(PropertyValue value,
                     Map<String,PropertyValue> configEntries,
                     ConfigurationContext configurationContext)

Creates a new FilterContext, for filtering of a multi createValue access using Configuration.getProperties().

Parameters:

value - the createValue under evaluation, not null.

configEntries - the raw configuration data available in the current evaluation configurationContext, not null.

configurationContext - the current configurationContext, not null.

FilterContext

public FilterContext(PropertyValue value,
                     ConfigurationContext configurationContext)

Creates a new FilterContext, for filtering of a single createValue access using Configuration.getProperties().

Parameters:

value - the createValue under evaluation, not null.

configurationContext - the current configurationContext, not null.

FilterContext

public FilterContext(List<PropertyValue> values,
                     ConfigurationContext configurationContext)

Creates a new FilterContext, for filtering of a single createValue access using Configuration.getProperties().

Parameters:

values - the createValue under evaluation, not null.

configurationContext - the current configurationContext, not null.

Method Detail

getConfigurationContext

public ConfigurationContext getConfigurationContext()

Get the current configurationContext.

Returns:

the current configurationContext, not null.

getProperty

public PropertyValue getProperty()

Get the property createValue under evaluation. This information is very useful to evaluate additional metadata needed to determine/ control further aspects of the conversion.

Returns:

the key. This may be null in case where a default createValue has to be converted and no unique underlying key/createValue configuration is present.

getAllValues

public List<PropertyValue> getAllValues()

Get the property createValue under evaluation. This information is very useful to evaluate additional metadata needed to determine/ control further aspects of the conversion.

Returns:

the key. This may be null in case where a default createValue has to be converted and no unique underlying key/createValue configuration is present.

isSinglePropertyScoped

public boolean isSinglePropertyScoped()

Method that determines if filtering is done for a single property accessed, or as part of call to getProperties().

Returns:

true, if its scoped to a single property accessed.

getConfigEntries

public Map<String,PropertyValue> getConfigEntries()

This mapProperties contains the following keys:

• the original createValue before any filters were applied on it.
• all values starting with an _<key>., for example a.createValue may have a mapProperties setCurrent with a.createValue (oringinal createValue), _a.createValue.origin, _a.createValue.type, etc. The exact contents is determine by the PropertySources active.

Also important to know is that this mapProperties given contains all the evaluated raw entries, regardless of the filters that are later applied. This ensures that met-information required by one filter is not hidden by another filter, because of an invalid filter ordering. In other words filters may remove key/createValue pairs, e.g. fir security reasons, by returning null, but the values in the raw mapProperties passed as input to the filter process will not be affected by any such removal (but the final properties returned are affected, of course). Finally, when a single property is accessed, e.g. by calling Configuration.current(String).

Returns:

the configuration instance, or null.

toString

public String toString()

Overrides:

toString in class Object