org.apache.tamaya.spi

Class PropertyValue

java.lang.Object

org.apache.tamaya.spi.PropertyValue

public final class PropertyValue
extends Object

Class modelling the result of a request for a property value. A property value is basically identified by its key. There might be reasons, where one want to further analyze, which PropertySources provided a value and which not, so it is possible to create a PropertyValue with a null value. Nevertheless in all cases the provider source (typically the name of the PropertySource) must be set.

Method Summary

Modifier and Type	Method and Description
static PropertyValueBuilder	builder(String key, String value, String source) Creates a new builder instance.
String	get(String key) Access the given key from this value.
Map<String,String>	getConfigEntries() Creates a full configuration map for this key, value pair and all its meta context data.
String	getKey() The requested key.
String	getValue() The value.
static PropertyValue	of(String key, String value, String source) Creates a new PropertyValue without any metadata..

Methods inherited from class java.lang.Object

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

Method Detail

getKey

public String getKey()

The requested key.

Returns:

the, key never null.

getValue

public String getValue()

The value.

Returns:

the value, in case a value is null it is valid to return {#code null} as result for PropertySource.get(String).

getConfigEntries

public Map<String,String> getConfigEntries()

Creates a full configuration map for this key, value pair and all its meta context data. This map is also used for subsequent processing, like value filtering.

Returns:

the property value entry map.

builder

public static PropertyValueBuilder builder(String key,
                                           String value,
                                           String source)

Creates a new builder instance.

Parameters:

key - the key, not null.

value - the value.

source - the source, typically the name of the PropertySource providing the value, not null.

Returns:

a new builder instance.

of

public static PropertyValue of(String key,
                               String value,
                               String source)

Creates a new PropertyValue without any metadata..

Parameters:

key - the key, not null.

value - the value.

source - the source, typically the name of the PropertySource providing the value, not null.

Returns:

a new property value instance, or null, if the value passed is null..

get

public String get(String key)

Access the given key from this value. Valid keys are the key or any meta-context key.

Parameters:

key - the key, not null.

Returns:

the value found, or null.