com.communote.server.api.core.config

Class AbstractConfigurationProperties<T extends ConfigurationPropertyConstant>

java.lang.Object

com.communote.server.api.core.config.AbstractConfigurationProperties<T>

Type Parameters:

T - the types of properties

Direct Known Subclasses:

ApplicationConfigurationProperties, ClientConfigurationProperties

public abstract class AbstractConfigurationProperties<T extends ConfigurationPropertyConstant>
extends Object

Abstract object that holds configuration properties.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
String	getAssertProperty(T key) Get the property, throw a runtime exception if the key does not exist.
abstract String	getProperty(T key) Returns the property value for the key as String.
boolean	getProperty(T key, boolean fallback) Returns the property for the key as boolean.
int	getProperty(T key, int fallback) Returns the property for the key as integer.
long	getProperty(T key, long fallback) Returns the property for the key as long.
String	getProperty(T key, String fallback) Returns the property for the key as string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractConfigurationProperties

public AbstractConfigurationProperties()

Method Detail

getAssertProperty

public String getAssertProperty(T key)

Get the property, throw a runtime exception if the key does not exist.

Parameters:

key - The key to get

Returns:

the property

getProperty

public abstract String getProperty(T key)

Returns the property value for the key as String.

Parameters:

key - the key

Returns:

the property value or null if there is no property for the key

getProperty

public boolean getProperty(T key,
                           boolean fallback)

Returns the property for the key as boolean. 'true', 'on' or 'yes' (case insensitive) will return true. 'false', 'off' or 'no' (case insensitive) will return false. If none of these values is set the fallback will be returned.

Parameters:

key - the key

fallback - the fallback to return if there is no property for the key or the property cannot be converted to boolean.

Returns:

the property value or the fallback if there is no property for the key or it cannot be converted into a boolean

getProperty

public int getProperty(T key,
                       int fallback)

Returns the property for the key as integer.

Parameters:

key - the key

fallback - the fallback to return if there is no property for the key

Returns:

the property value or the fallback if there is no property for the key or it cannot be converted into an integer

getProperty

public long getProperty(T key,
                        long fallback)

Returns the property for the key as long.

Parameters:

key - the key

fallback - the fallback to return if there is no property for the key

Returns:

the property value or the fallback if there is no property for the key or it cannot be converted into a long

getProperty

public String getProperty(T key,
                          String fallback)

Returns the property for the key as string.

Parameters:

key - the key

fallback - the fallback to return if there is no property for the key

Returns:

the property value or the fallback if there is no property for the key