org.apache.tamaya

Class ConfigurationProvider

java.lang.Object

org.apache.tamaya.ConfigurationProvider

public final class ConfigurationProvider
extends Object

Static access to the Configuration for the very application.

Method Summary

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