org.apache.tamaya.spi

Interface PropertyFilter

public interface PropertyFilter

Interface for filtering the current map of properties during the evaluation of the chain of PropertySources. Filters can be registered using the ServiceContext. The ordinal hereby is defined by the corresponding @Priority annotation.

Filters

Method Summary

Methods

Modifier and Type	Method and Description
String	filterProperty(String value, FilterContext context) Maps the current valueToBeFiltered value to a new value.

Method Detail

filterProperty

String filterProperty(String value,
                    FilterContext context)

Maps the current valueToBeFiltered value to a new value. The resulting value will be used as the result passed to the user.

If a filter is currently not available, it should just pass the input map to the method's output.

Returning null will remove the entry.

Implementation specification

Implementations of this class must be

• reentrant
• thread-safe

Parameters:

value - the value to be filtered, which also can be null if removed by another filter.

context - the filter context, not null.

Returns:

the filtered value, or null if the value should be removed alltogether.