org.apache.tamaya.spi

Class PropertyValueBuilder

java.lang.Object

org.apache.tamaya.spi.PropertyValueBuilder

public class PropertyValueBuilder
extends Object

Builder to create a PropertyValue instance.

Constructor Summary

Constructors

Constructor and Description
PropertyValueBuilder(String key, String value, String source) Create a new builder instance, for a given set of parameters.

Method Summary

Methods

Modifier and Type	Method and Description
PropertyValueBuilder	addContextData(String key, Object value) Add an additional context data information.
PropertyValue	build() Creates a new immutable PropertyValue.
PropertyValueBuilder	setContextData(Map<String,String> contextData) Replaces/sets the context data.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyValueBuilder

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

Create a new builder instance, for a given set of parameters.

Parameters:

key - to access a property value.

value - the value, not null. If a value is null PropertySource.get(String) should return null.

source - property source.

Method Detail

setContextData

public PropertyValueBuilder setContextData(Map<String,String> contextData)

Replaces/sets the context data.

Parameters:

contextData - the context data to be applied, not null. Note that all keys should only identify the context data item. the builder does create a corresponding metadata entry, e.g.

                    provider=myProviderName
                    ttl=250
                    creationIndex=1
                    modificationIndex=23
                    

will be mapped, given a key test.env.name to

                    _test.env.name.provider=myProviderName
                    _test.env.name.ttl=250
                    _test.env.name.creationIndex=1
                    _test.env.name.modificationIndex=23
                    

Returns:

the builder for chaining.

addContextData

public PropertyValueBuilder addContextData(String key,
                                  Object value)

Add an additional context data information.

Parameters:

key - the context data key, not null.

value - the context value, not null (will be converted to String).

Returns:

the builder for chaining.

build

public PropertyValue build()

Creates a new immutable PropertyValue.

Returns:

a new immutable PropertyValue, never null.

toString

public String toString()

Overrides:

toString in class Object