ConfigurationProvider (Apache Tamaya Base 0.3-incubating API)

java.lang.Object
+
- org.apache.tamaya.ConfigurationProvider
+

+
+
+
```
public final class ConfigurationProvider
+extends Object
```
+
Static access to the Configuration for the very application.
+

+ +

Method Summary

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

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Configuration`	`createConfiguration(ConfigurationContext context)` + Creates a new configuration instance based on the given context. +
`static Configuration`	`getConfiguration()` + Access the current configuration. +
`static ConfigurationContext`	`getConfigurationContext()` + Deprecated. + Use `Configuration.getContext()` instead of. + +
`static ConfigurationContextBuilder`	`getConfigurationContextBuilder()` + Create a new `ConfigurationContextBuilder` instance. +
`static void`	`setConfiguration(Configuration config)` + This method allows to replace the current default `Configuration` with a new + instance. +
`static void`	`setConfigurationContext(ConfigurationContext context)` + Deprecated. + Use #setConfiguration(Configuration) instead of. + +

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

+ +
- + + +
  Method Detail
  + + + +
  - +
    getConfiguration
    +
```
public static Configuration getConfiguration()
```
    +
    Access the current configuration.
    +
    +
    Returns:
    +
    the corresponding Configuration instance, never null.
    +
    +
  + + + +
  - +
    createConfiguration
    +
```
public static Configuration createConfiguration(ConfigurationContext context)
```
    +
    Creates a new configuration instance based on the given context.
    +
    +
    Parameters:
    +
    context - the configuration context, not null.
    +
    Returns:
    +
    a new Configuration instance, never null.
    +
    +
  + + + +
  - +
    getConfigurationContext
    +
```
@Deprecated
+public static ConfigurationContext getConfigurationContext()
```
    +
    Deprecated. Use Configuration.getContext() instead of.
    +
    Get access to the current ConfigurationContext.
    +
    +
    Returns:
    +
    the current ConfigurationContext, never null.
    +
    +
  + + + +
  - +
    setConfigurationContext
    +
```
@Deprecated
+public static void setConfigurationContext(ConfigurationContext context)
```
    +
    Deprecated. Use #setConfiguration(Configuration) instead of.
    +
    This method allows to replace the current ConfigurationContext with a new + instance. This can be used to update the context with a new one, e.g. because some of the configuration + data has changed and should be updated. It is the responsibility of the ConfigurationProvider to trigger + corresponding update events for the current Configuration, so observing + listeners can do whatever is appropriate to react to any given configuration changes.
    +
    +
    Parameters:
    +
    context - the new ConfigurationContext to be applied.
    +
    Throws:
    +
    UnsupportedOperationException - if the current provider is read-only and does not support + applying a new ConfigurationContext.
    +
    +
  + + + +
  - +
    setConfiguration
    +
```
public static void setConfiguration(Configuration config)
```
    +
    This method allows to replace the current default Configuration with a new + instance. It is the responsibility of the ConfigurationProvider to trigger + corresponding update events for the current Configuration, so observing + listeners can do whatever is appropriate to react to any given configuration change.
    +
    +
    Parameters:
    +
    config - the new Configuration to be applied, not null
    +
    Throws:
    +
    UnsupportedOperationException - if the current provider is read-only and + does not support + applying a new Configuration.
    +
    +
  + + + +
  - +
    getConfigurationContextBuilder
    +
```
public static ConfigurationContextBuilder getConfigurationContextBuilder()
```
    +
    Create a new ConfigurationContextBuilder instance. This method creates + a new builder instance that is not related to any concrete ConfigurationContext. + You can use setConfigurationContext(org.apache.tamaya.spi.ConfigurationContext) to change the + current configuration context.
    +
    +
    Returns:
    +
    a new, empty ConfigurationContextBuilder, never null.
    +
    See Also:
    +
    setConfigurationContext(org.apache.tamaya.spi.ConfigurationContext), +ConfigurationContext
    +
    +
  +
+

java.lang.Object
+
- org.apache.tamaya.TypeLiteral<T>
+

+
+
Type Parameters:
+
T - the type, including all type parameters
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
+
```
public class TypeLiteral<T>
+extends Object
+implements Serializable
```
+
Class for instantiation of objects that represent parameterized types + with current parameters.
+ +
An object that represents a parameterized type may be obtained by + subclassing TypeLiteral.
+ +
```
+ TypeLiteral<List<Integer>> stringListType = new TypeLiteral<List<Integer>>() {};
+ 
```
+
+
See Also:
+
Serialized Form
+
+

+ +

+ + +

Constructor Summary

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

Constructors
Constructor and Description
`TypeLiteral()` + Constructor only for directly implemeting a TypeLiteral hereby dynamically implementing a generic interface. +
`TypeLiteral(Type definedType)` + Constructor. +

+ +

+ + +

Method Summary

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`protected Type`	`getDefinedType(Class<?> clazz)`
`static Type[]`	`getGenericInterfaceTypeParameters(Class<?> clazz, + Class<?> interfaceType)` + Checks the current implemented generic interfaces and evaluates the given single type parameter. +
`Class<T>`	`getRawType()` + Returns basic raw Java type. +
`Type`	`getType()`
`static Type[]`	`getTypeParameters(Type type)` + Method that checks the class's type for a generic interface implementation type. +
`int`	`hashCode()`
`static <R> TypeLiteral<R>`	`of(Type type)` + Creates a new TypeLiteral based on a given type. +
`String`	`toString()`

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

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    TypeLiteral
    +
```
public TypeLiteral(Type definedType)
```
    +
    Constructor.
    +
    +
    Parameters:
    +
    definedType - the defined type.
    +
    +
  + + + +
  - +
    TypeLiteral
    +
```
public TypeLiteral()
```
    +
    Constructor only for directly implemeting a TypeLiteral hereby dynamically implementing a generic interface.
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    of
    +
```
public static <R> TypeLiteral<R> of(Type type)
```
    +
    Creates a new TypeLiteral based on a given type.
    +
    +
    Type Parameters:
    +
    R - the literal generic type.
    +
    Parameters:
    +
    type - the type , not null.
    +
    Returns:
    +
    the corresponding TypeLiteral, never null.
    +
    +
  + + + +
  - +
    getGenericInterfaceTypeParameters
    +
```
public static Type[] getGenericInterfaceTypeParameters(Class<?> clazz,
+                                                       Class<?> interfaceType)
```
    +
    Checks the current implemented generic interfaces and evaluates the given single type parameter.
    +
    +
    Parameters:
    +
    clazz - the class to check, not null.
    +
    interfaceType - the interface type to be checked, not null.
    +
    Returns:
    +
    the generic type parameter, or null, if it cannot be evaluated.
    +
    +
  + + + +
  - +
    getTypeParameters
    +
```
public static Type[] getTypeParameters(Type type)
```
    +
    Method that checks the class's type for a generic interface implementation type.
    +
    +
    Parameters:
    +
    type - the type, not null.
    +
    Returns:
    +
    the generic type parameter of the given single type generic interfaceType, or null.
    +
    +
  + + + +
  - +
    getType
    +
```
public final Type getType()
```
    +
  + + + +
  - +
    getRawType
    +
```
public final Class<T> getRawType()
```
    +
    Returns basic raw Java type.
    +
    +
    Returns:
    +
    the actual type represented by this object
    +
    +
  + + + +
  - +
    getDefinedType
    +
```
protected Type getDefinedType(Class<?> clazz)
```
    +
  + + + +
  - +
    hashCode
    +
```
public int hashCode()
```
    +
    +
    Overrides:
    +
    hashCode in class Object
    +
    +
  + + + +
  - +
    equals
    +
```
public boolean equals(Object obj)
```
    +
    +
    Overrides:
    +
    equals in class Object
    +
    +
  + + + +
  - +
    toString
    +
```
public String toString()
```
    +
    +
    Overrides:
    +
    toString in class Object
    +
    +
  +
+

Packages that use ConfigOperator
Package	Description
org.apache.tamaya
org.apache.tamaya.core.internal

Packages that use ConfigOperator

Package

Description

org.apache.tamaya

org.apache.tamaya.core.internal

Methods in org.apache.tamaya with parameters of type ConfigOperator
Modifier and Type	Method and Description
`Configuration`	Configuration.`with(ConfigOperator operator)` + Extension point for adjusting configuration. +

Methods in org.apache.tamaya with parameters of type ConfigOperator

Modifier and Type

Method and Description

Configuration

Configuration.with(ConfigOperator operator) +

Extension point for adjusting configuration.

Methods in org.apache.tamaya.core.internal with parameters of type ConfigOperator
Modifier and Type	Method and Description
`Configuration`	DefaultConfiguration.`with(ConfigOperator operator)`

Methods in org.apache.tamaya.core.internal with parameters of type ConfigOperator

Modifier and Type

Method and Description

Configuration

DefaultConfiguration.with(ConfigOperator operator)

Packages that use ConfigQuery
Package	Description
org.apache.tamaya
org.apache.tamaya.core.internal

Packages that use ConfigQuery

Package

Description

org.apache.tamaya

org.apache.tamaya.core.internal

Methods in org.apache.tamaya with parameters of type ConfigQuery
Modifier and Type	Method and Description
`<T> T`	Configuration.`query(ConfigQuery<T> query)` + Query a configuration. +

Methods in org.apache.tamaya with parameters of type ConfigQuery

Modifier and Type

Method and Description

<T> T

Configuration.query(ConfigQuery<T> query) +

Query a configuration.

Methods in org.apache.tamaya.core.internal with parameters of type ConfigQuery
Modifier and Type	Method and Description
`<T> T`	DefaultConfiguration.`query(ConfigQuery<T> query)`

Methods in org.apache.tamaya.core.internal with parameters of type ConfigQuery

Modifier and Type

Method and Description

<T> T

DefaultConfiguration.query(ConfigQuery<T> query)

Class ConfigurationProvider

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getConfiguration

createConfiguration

getConfigurationContext

setConfigurationContext

setConfiguration

getConfigurationContextBuilder

Class TypeLiteral<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TypeLiteral

TypeLiteral

Method Detail

of

getGenericInterfaceTypeParameters

getTypeParameters

getType

getRawType

getDefinedType

hashCode

equals

toString

Uses of Class
org.apache.tamaya.ConfigException

Uses of Interface
org.apache.tamaya.ConfigOperator

Uses of ConfigOperator in org.apache.tamaya

Uses of ConfigOperator in org.apache.tamaya.core.internal

Uses of Interface
org.apache.tamaya.ConfigQuery

Uses of ConfigQuery in org.apache.tamaya

Uses of ConfigQuery in org.apache.tamaya.core.internal

Class ConfigurationProvider

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getConfiguration

createConfiguration

getConfigurationContext

setConfigurationContext

setConfiguration

getConfigurationContextBuilder

Class TypeLiteral<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TypeLiteral

TypeLiteral

Method Detail

of

getGenericInterfaceTypeParameters

getTypeParameters

getType

getRawType

getDefinedType

hashCode

equals

toString

Uses of Classorg.apache.tamaya.ConfigException

Uses of Interfaceorg.apache.tamaya.ConfigOperator

Uses of ConfigOperator in org.apache.tamaya

Uses of ConfigOperator in org.apache.tamaya.core.internal

Uses of Interfaceorg.apache.tamaya.ConfigQuery

Uses of ConfigQuery in org.apache.tamaya

Uses of ConfigQuery in org.apache.tamaya.core.internal

Uses of Class
org.apache.tamaya.ConfigException

Uses of Interface
org.apache.tamaya.ConfigOperator

Uses of Interface
org.apache.tamaya.ConfigQuery