com.sdm.quasar.client.core.common.config
Interface ConfigurationDescriptor

All Superinterfaces:

Disposable

All Known Implementing Classes:

AbstractConfigurationDescriptor, ValueConfigurationDescriptor

public interface ConfigurationDescriptor

extends Disposable

Describes a configuration entry of a ConfigManager.

Version:

1.$Revision$

Author:

Thomas Wolf

Method Summary

java.lang.String	getKey() Returns the key for the configuration entry.
java.lang.Object	getValue() Returns the configuration value.
boolean	isLoaded() Returns true, iff this ConfigurationDescriptor is loaded; this means, loadConfiguration(ConfigProvider) was called before and the value can be accessed.
void	loadConfiguration(ConfigProvider configProvider) Loads the configuration, which means, that getValue() might be called.

Methods inherited from interface com.sdm.quasar.client.core.common.Disposable

dispose

Method Detail

getKey

public java.lang.String getKey()

Returns the key for the configuration entry.

getValue

public java.lang.Object getValue()

Returns the configuration value. The caller must ensure, that this method will only be called, if the ConfigurationDescriptor is loaded.

isLoaded

public boolean isLoaded()

Returns true, iff this ConfigurationDescriptor is loaded; this means, loadConfiguration(ConfigProvider) was called before and the value can be accessed.

loadConfiguration

public void loadConfiguration(ConfigProvider configProvider)

Loads the configuration, which means, that getValue() might be called. The call occures only once, until Disposable.dispose() is called.

Parameters:

configProvider - the ConfigProvider, that may be used to access other values.