org.apache.tamaya.core

Class ConfigurationFunctions

java.lang.Object

org.apache.tamaya.core.ConfigurationFunctions

public final class ConfigurationFunctions
extends java.lang.Object

Accessor that provides useful functions along with configuration.

Method Summary

Modifier and Type	Method and Description
static java.util.function.Function<org.apache.tamaya.Configuration,java.lang.Boolean>	containsArea(java.lang.String areaKey) Return a query to evaluate to evaluate if an area exists.
static java.util.function.Function<org.apache.tamaya.Configuration,java.util.Set<java.lang.String>>	getAreas() Return a query to evaluate the set with all fully qualifies area names.
static java.util.function.Function<org.apache.tamaya.Configuration,java.util.Set<java.lang.String>>	getAreas(java.util.function.Predicate<java.lang.String> predicate) Return a query to evaluate the set with all fully qualified area names, containing only the areas that match the predicate and have properties attached.
static java.util.function.Function<org.apache.tamaya.Configuration,java.util.Set<java.lang.String>>	getTransitiveAreas() Return a query to evaluate the set with all fully qualified area names, containing the transitive closure also including all subarea names, regardless if properties are accessible or not.
static java.util.function.Function<org.apache.tamaya.Configuration,java.util.Set<java.lang.String>>	getTransitiveAreas(java.util.function.Predicate<java.lang.String> predicate) Return a query to evaluate the set with all fully qualified area names, containing the transitive closure also including all subarea names, regardless if properties are accessible or not.
static boolean	isKeyInArea(java.lang.String key, java.lang.String areaKey) Calculates the current area key and compares it with the given key.
static java.util.function.UnaryOperator<org.apache.tamaya.Configuration>	selectArea(java.lang.String areaKey) Creates a ConfigOperator that creates a Configuration containing only keys that are contained in the given area (non recursive).
static java.util.function.UnaryOperator<org.apache.tamaya.Configuration>	selectArea(java.lang.String areaKey, boolean stripKeys) Creates a ConfigOperator that creates a Configuration containing only keys that are contained in the given area (non recursive).
static java.util.function.UnaryOperator<org.apache.tamaya.Configuration>	selectAreaRecursive(java.lang.String areaKey) Creates a ConfigOperator that creates a Configuration containing only keys that are contained in the given area (recursive).
static java.util.function.UnaryOperator<org.apache.tamaya.Configuration>	selectAreaRecursive(java.lang.String areaKey, boolean stripKeys) Creates a ConfigOperator that creates a Configuration containing only keys that are contained in the given area (recursive).

Methods inherited from class java.lang.Object

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

Method Detail

selectArea

public static java.util.function.UnaryOperator<org.apache.tamaya.Configuration> selectArea(java.lang.String areaKey)

Creates a ConfigOperator that creates a Configuration containing only keys that are contained in the given area (non recursive). Hereby the area key is stripped away fromMap the resulting key.

Parameters:

areaKey - the area key, not null

Returns:

the area configuration, with the areaKey stripped away.

selectArea

public static java.util.function.UnaryOperator<org.apache.tamaya.Configuration> selectArea(java.lang.String areaKey,
                                                                                           boolean stripKeys)

Creates a ConfigOperator that creates a Configuration containing only keys that are contained in the given area (non recursive).

Parameters:

areaKey - the area key, not null

stripKeys - if set to true, the area key is stripped away fromMap the resulting key.

Returns:

the area configuration, with the areaKey stripped away.

isKeyInArea

public static boolean isKeyInArea(java.lang.String key,
                                  java.lang.String areaKey)

Calculates the current area key and compares it with the given key.

Parameters:

key - the fully qualified entry key, not null

areaKey - the area key, not null

Returns:

true, if the entry is exact in this area

getAreas

public static java.util.function.Function<org.apache.tamaya.Configuration,java.util.Set<java.lang.String>> getAreas()

Return a query to evaluate the set with all fully qualifies area names. This method should return the areas as accurate as possible, but may not provide a complete set of areas that are finally accessible, especially when the underlying storage does not support key iteration.

Returns:

s set with all areas, never null.

getTransitiveAreas

public static java.util.function.Function<org.apache.tamaya.Configuration,java.util.Set<java.lang.String>> getTransitiveAreas()

Return a query to evaluate the set with all fully qualified area names, containing the transitive closure also including all subarea names, regardless if properties are accessible or not. This method should return the areas as accurate as possible, but may not provide a complete set of areas that are finally accessible, especially when the underlying storage does not support key iteration.

Returns:

s set with all transitive areas, never null.

getAreas

public static java.util.function.Function<org.apache.tamaya.Configuration,java.util.Set<java.lang.String>> getAreas(java.util.function.Predicate<java.lang.String> predicate)

Return a query to evaluate the set with all fully qualified area names, containing only the areas that match the predicate and have properties attached. This method should return the areas as accurate as possible, but may not provide a complete set of areas that are finally accessible, especially when the underlying storage does not support key iteration.

Parameters:

predicate - A predicate to deternine, which areas should be returned, not null.

Returns:

s set with all areas, never null.

getTransitiveAreas

public static java.util.function.Function<org.apache.tamaya.Configuration,java.util.Set<java.lang.String>> getTransitiveAreas(java.util.function.Predicate<java.lang.String> predicate)

Return a query to evaluate the set with all fully qualified area names, containing the transitive closure also including all subarea names, regardless if properties are accessible or not. This method should return the areas as accurate as possible, but may not provide a complete set of areas that are finally accessible, especially when the underlying storage does not support key iteration.

Parameters:

predicate - A predicate to deternine, which areas should be returned, not null.

Returns:

s set with all transitive areas, never null.

containsArea

public static java.util.function.Function<org.apache.tamaya.Configuration,java.lang.Boolean> containsArea(java.lang.String areaKey)

Return a query to evaluate to evaluate if an area exists. In case where the underlying storage implementation does not allow querying the keys available, false should be returned.

Parameters:

areaKey - the configuration area (sub)path.

Returns:

true, if such a node exists.

selectAreaRecursive

public static java.util.function.UnaryOperator<org.apache.tamaya.Configuration> selectAreaRecursive(java.lang.String areaKey)

Creates a ConfigOperator that creates a Configuration containing only keys that are contained in the given area (recursive). Hereby the area key is stripped away fromMap the resulting key.

Parameters:

areaKey - the area key, not null

Returns:

the area configuration, with the areaKey stripped away.

selectAreaRecursive

public static java.util.function.UnaryOperator<org.apache.tamaya.Configuration> selectAreaRecursive(java.lang.String areaKey,
                                                                                                    boolean stripKeys)

Creates a ConfigOperator that creates a Configuration containing only keys that are contained in the given area (recursive).

Parameters:

areaKey - the area key, not null

stripKeys - if set to true, the area key is stripped away fromMap the resulting key.

Returns:

the area configuration, with the areaKey stripped away.