org.apache.tamaya.spi

Class FilterContext

java.lang.Object

org.apache.tamaya.spi.FilterContext

public class FilterContext
extends Object

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

See Also:

PropertyFilter

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Map<String,PropertyValue>	getConfigEntries() This map contains the following keys: the original value before any filters were applied on it.
ConfigurationContext	getContext() Get the current context.
PropertyValue	getProperty() Get the property value 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 context)

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

Parameters:

value - the value under evaluation, not null.

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

context - the current context, not null.

FilterContext

public FilterContext(PropertyValue value,
                     ConfigurationContext context)

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

Parameters:

value - the value under evaluation, not null.

context - the current context, not null.

Method Detail

getContext

public ConfigurationContext getContext()

Get the current context.

Returns:

the current context, not null.

getProperty

public PropertyValue getProperty()

Get the property value 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 value has to be converted and no unique underlying key/value 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 map contains the following keys:

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

Also important to know is that this map 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/value pairs, e.g. fir security reasons, by returning null, but the values in the raw map 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.get(String).

Returns:

the configuration instance, or null.

toString

public String toString()

Overrides:

toString in class Object