org.openhubframework.openhub.api.configuration

Interface ConfigurationItem<T extends Serializable>

Type Parameters:

T - represents type of a configuration item (allowed types are determined by backing repository)

All Known Implementing Classes:

ConfigurationItemImpl, FixedConfigurationItem

public interface ConfigurationItem<T extends Serializable>

Contract of configuration holder, which is wrapping one config item allowing to manage that.

Since:

2.0

Author:

Tomas Hanus

Method Summary

Modifier and Type	Method and Description
T	getValue() Gets required configuration item.
T	getValue(T defaultValue) Gets configuration item and specifies a default value in case configuration item is not found.
void	setValue(T newValue) Sets a new value for the configuration item.

Method Detail

getValue

T getValue()
    throws ConfigurationException

Gets required configuration item.

Returns:

Configuration item loaded from repository

Throws:

ConfigurationException - When configuration item is not found in the repository (i.e. application requires to have this configuration item)

getValue

T getValue(T defaultValue)

Gets configuration item and specifies a default value in case configuration item is not found.

Parameters:

defaultValue - as default value for item

Returns:

Configuration item loaded from repository or defaultValue in case item is not found in repository

setValue

void setValue(T newValue)

Sets a new value for the configuration item.

Parameters:

newValue - for configuration item