PropertyValueCombinationPolicy

+
+
+
```
public interface PropertyValueCombinationPolicy
```
+
Policy that determines how the final value of a configuration entry is evaluated. An instances of this + interface can be registered to get control how multiple PropertySources are combined. This is useful in cases + where the default overriding policy as implemented in DEFAULT_OVERRIDING_COLLECTOR is not matching + the need of the current application, e.g. then entries containing multiple values should be combined to new + values instead of overridden.
+

+ +

Field Summary

+ + + + + + + + + + +

Fields
Modifier and Type	Field and Description
`static PropertyValueCombinationPolicy`	`DEFAULT_OVERRIDING_COLLECTOR` + Default overriding collector, where each existing entry (`current` is overridden by a subsequent non-null + entry evaluated by `propertySource.get(key)`. +

+ +

+ + +

Method Summary

+ + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`collect(java.lang.String currentValue, + java.lang.String key, + PropertySource propertySource)` + Method that is called for each value evaluated by a PropertySource for the given key. +

+ +
- + + +
  Field Detail
  + + + +
  - +
    DEFAULT_OVERRIDING_COLLECTOR
    +
```
static final PropertyValueCombinationPolicy DEFAULT_OVERRIDING_COLLECTOR
```
    +
    Default overriding collector, where each existing entry (current is overridden by a subsequent non-null + entry evaluated by propertySource.get(key).
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    collect
    +
```
java.lang.String collect(java.lang.String currentValue,
+                         java.lang.String key,
+                         PropertySource propertySource)
```
    +
    Method that is called for each value evaluated by a PropertySource for the given key. This method is called + either when a single key is accessed, e.g. by calling org.apache.tamaya.Configuration.getXXX, but also + when the full configuration property map is accessed by calling + Configuration.getProperties().
    +
    +
    Parameters:
    +
    currentValue - the current value, including null. + The collector should either combine the existing value with value from currentValue + or replace the value in currentValue with valueRead, hereby returning the + result to be used as new currentValue.
    +
    key - The current key to be evaluated.
    +
    propertySource - The PropertySource that may return an value for the given key. The PropertySource given + may be evaluated for additional meta-data, how the given values are to be combined. + Note that the value returned by a PropertySource can be null. In that case + currentValue should be returned in almost all cases.
    +
    Returns:
    +
    the value to be used for future evaluation.
    +
    +
  +
+

+
+
+
```
public interface ServiceContext
```
+
This class models the component that is managing the lifecycle current the + services used by the Configuration API.
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<T> T`	`getService(java.lang.Class<T> serviceType)` + Access a service singleton via its type. +
`<T> java.util.List<T>`	`getServices(java.lang.Class<T> serviceType)` + Access a list current services, given its type. +
`int`	`ordinal()`

+ +
- + + +
  Method Detail
  + + + +
  - +
    ordinal
    +
```
int ordinal()
```
    +
    +
    Returns:
    +
    ordinal of the ServiceContext. The one with the highest ordinal will be taken.
    +
    +
  + + + +
  - +
    getService
    +
```
<T> T getService(java.lang.Class<T> serviceType)
```
    +
    Access a service singleton via its type. + If multiple implementations for the very serviceType exist then + the one with the highest javax.annotation.Priority will be used.
    +
    +
    Parameters:
    +
    serviceType - the service type.
    +
    Returns:
    +
    The instance to be used, never null
    +
    Throws:
    +
    ConfigException - if there are multiple service implementations with the maximum priority.
    +
    +
  + + + +
  - +
    getServices
    +
```
<T> java.util.List<T> getServices(java.lang.Class<T> serviceType)
```
    +
    Access a list current services, given its type. The bootstrap mechanism should + order the instance for precedence, hereby the most significant should be + first in order.
    +
    +
    Parameters:
    +
    serviceType - the service type.
    +
    Returns:
    +
    The instance to be used, never null
    +
    +
  +
+

java.lang.Object
+
- org.apache.tamaya.spi.ServiceContextManager
+

+
+
+
```
public final class ServiceContextManager
+extends java.lang.Object
```
+
This singleton provides access to the services available in the current ServiceContext. The + behaviour can be adapted, by calling set(ServiceContext) before accessing any + services.
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ServiceContext`	`getServiceContext()` + Ge `ServiceContext`. +
`static ServiceContext`	`set(ServiceContext serviceContextProvider)` + Replace the current `ServiceContext` in use. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Method Detail
  + + + +
  - +
    set
    +
```
public static ServiceContext set(ServiceContext serviceContextProvider)
```
    +
    Replace the current ServiceContext in use.
    +
    +
    Parameters:
    +
    serviceContextProvider - the new ServiceContext, not null.
    +
    +
  + + + +
  - +
    getServiceContext
    +
```
public static ServiceContext getServiceContext()
```
    +
    Ge ServiceContext. If necessary the ServiceContext will be laziliy loaded.
    +
    +
    Returns:
    +
    the ServiceContext used.
    +
    +
  +
+

org.apache.tamaya.spi

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Interface Summary
Interface	Description
ConfigurationContext	+ Central SPI for programmatically dealing with the setup of the configuration system. +
ConfigurationContextBuilder	+ A builder for creating new or adapting instances of `ConfigurationContext`. +
ConfigurationProviderSpi	+ SPI that must be implemented to provide the component that manages all `Configuration` + instances in a system. +
PropertyFilter	+ Interface for filtering the current map of properties during the evaluation of the chain of PropertySources. +
PropertySource	+ This interface models a provider that serves configuration properties. +
PropertySourceProvider	+ Implement this interfaces to provide a PropertySource provider which + is able to register multiple PropertySources. +
PropertyValueCombinationPolicy	+ Policy that determines how the final value of a configuration entry is evaluated. +
ServiceContext	+ This class models the component that is managing the lifecycle current the + services used by the Configuration API. +

+ + + + + + + + + + + + +
Class Summary
Class Description
ServiceContextManager +
This singleton provides access to the services available in the current ServiceContext.
+
+

Class Summary
Class	Description
ServiceContextManager	+ This singleton provides access to the services available in the current `ServiceContext`. +

Packages
Package	Description
org.apache.tamaya
org.apache.tamaya.spi

Packages

Package

Description

org.apache.tamaya

org.apache.tamaya.spi

Class Hierarchy

java.lang.Object +

org.apache.tamaya.ConfigurationProvider
org.apache.tamaya.spi.ServiceContextManager
java.lang.Throwable (implements java.io.Serializable) +
- java.lang.Exception +
  - java.lang.RuntimeException +
    - org.apache.tamaya.ConfigException
    +
  +
+
org.apache.tamaya.TypeLiteral<T> (implements java.io.Serializable)

Package org.apache.tamaya

+ + +

Class org.apache.tamaya.ConfigException extends java.lang.RuntimeException implements Serializable

serialVersionUID:: -5886094818057522680L

+ + +

Class org.apache.tamaya.TypeLiteral extends java.lang.Object implements Serializable

serialVersionUID:: 1L

+
Serialized Fields
+
- +
  type
  +
```
java.lang.reflect.Type type
```
  +
+

Interface PropertyValueCombinationPolicy

Field Summary

Method Summary

Field Detail

DEFAULT_OVERRIDING_COLLECTOR

Method Detail

collect

Interface ServiceContext

Method Summary

Method Detail

ordinal

getService

getServices

Class ServiceContextManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

set

getServiceContext

org.apache.tamaya.spi

Interfaces

Classes

Package org.apache.tamaya.spi

Hierarchy For Package org.apache.tamaya.spi

Class Hierarchy

Interface Hierarchy

Packages

Hierarchy For All Packages

Class Hierarchy

Interface Hierarchy

Serialized Form

Package org.apache.tamaya

Class org.apache.tamaya.ConfigException extends java.lang.RuntimeException implements Serializable

Class org.apache.tamaya.TypeLiteral extends java.lang.Object implements Serializable

Serialized Fields

type