PropertyValue (Apache Tamaya API 0.3-incubating API)

java.lang.Object
- org.apache.tamaya.spi.PropertyValue

All Implemented Interfaces:

Serializable
```
public final class PropertyValue
extends Object
implements Serializable
```
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.

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PropertyValueBuilder`	`builder(String key, String source)` Creates a new builder instance.
`static PropertyValueBuilder`	`builder(String key, String value, String source)` Creates a new builder instance.
`boolean`	`equals(Object o)`
`String`	`getKey()` The requested key.
`Map<String,String>`	`getMetaEntries()` Creates a full configuration map for this key, value pair and all its meta context data.
`String`	`getMetaEntry(String key)` Access the given key from this value.
`String`	`getSource()` The source.
`String`	`getValue()` The value.
`int`	`hashCode()`
`static Map<String,PropertyValue>`	`map(Map<String,String> config, String source)` Maps a map of `Map<String,String>` to a `Map<String,PropertyValue>`.
`static Map<String,PropertyValue>`	`map(Map<String,String> config, String source, Map<String,String> metaData)` Maps a map of `Map<String,String>` to a `Map<String,PropertyValue>`.
`static PropertyValue`	`of(String key, String value, String source)` Creates a new PropertyValue without any metadata..
`PropertyValueBuilder`	`toBuilder()` Creates a new builder instance based on this item.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getKey
```
public String getKey()
```
    The requested key.
    
    Returns:
    
    the, key never null.
  - getSource
```
public String getSource()
```
    The source.
    
    Returns:
    
    the source, which provided the value, not null.
    
    See Also:
    
    PropertySource.getName().
  - 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).
  - getMetaEntries
```
public Map<String,String> getMetaEntries()
```
    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 source)
```
    Creates a new builder instance.
    
    Parameters:
    
    key - the key, not null.
    
    source - the source, typically the name of the PropertySource providing the value, not null.
    
    Returns:
    
    a new builder instance.
  - builder
```
public static PropertyValueBuilder builder(String key,
                                           String value,
                                           String source)
```
    Creates a new builder instance.
    
    Parameters:
    
    key - the key, not null.
    
    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..
  - getMetaEntry
```
public String getMetaEntry(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.
  - toBuilder
```
public PropertyValueBuilder toBuilder()
```
    Creates a new builder instance based on this item.
    
    Returns:
    
    a new builder, never null.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - map
```
public static Map<String,PropertyValue> map(Map<String,String> config,
                                            String source)
```
    Maps a map of Map<String,String> to a Map<String,PropertyValue>.
    
    Parameters:
    
    config - the String based map, not null.
    
    source - the source name, not null.
    
    Returns:
    
    the corresponding value based map.
  - map
```
public static Map<String,PropertyValue> map(Map<String,String> config,
                                            String source,
                                            Map<String,String> metaData)
```
    Maps a map of Map<String,String> to a Map<String,PropertyValue>.
    
    Parameters:
    
    config - the String based map, not null.
    
    source - the source name, not null.
    
    metaData - additional metadata, not null.
    
    Returns:
    
    the corresponding value based map.

Class PropertyValue

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getKey

getSource

getValue

getMetaEntries

builder

builder

of

getMetaEntry

toBuilder

equals

hashCode

toString

map

map