org.wisepersist.apuava.settings

Class AbstractSettings

java.lang.Object

org.wisepersist.apuava.settings.AbstractSettings

All Implemented Interfaces:

Settings

public abstract class AbstractSettings
extends java.lang.Object
implements Settings

The abstract class for most used config getter methods.

Constructor Summary

Constructors

Constructor and Description
AbstractSettings(EnvType env) Constructor by EnvType.
AbstractSettings(java.lang.String... paths) Constructor by config paths.

Method Summary

Modifier and Type	Method and Description
protected void	ensureConfigNotNull() Ensures that the mergedProperties is not null.
protected java.lang.String	get(java.lang.String name) Gets a setting value by given setting name.
protected java.lang.String	get(java.lang.String name, java.lang.String defaultVal) Gets a setting value by given setting name.
protected abstract java.lang.String	getAppConfigFolder() Gets the settings folder name on resource.
java.lang.Boolean	getBoolean(java.lang.String key) Get config setting.
protected abstract java.lang.Class	getClassType() Gets the type of the concrete settings class.
java.lang.Double	getDouble(java.lang.String key) Get config setting.
java.lang.Double	getDouble(java.lang.String key, double defaultVal) Get config setting.
java.lang.Integer	getInt(java.lang.String key) Get config setting.
java.lang.Integer	getInt(java.lang.String key, int defaultVal) Get config setting.
java.lang.String	getString(java.lang.String key) Gets a setting value by given setting name.
java.lang.String	getString(java.lang.String key, java.lang.String defaultVal) Gets a setting value by given setting name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSettings

public AbstractSettings(EnvType env)

Constructor by EnvType.

Parameters:

env - The env of this settings.

AbstractSettings

public AbstractSettings(java.lang.String... paths)

Constructor by config paths.

Parameters:

paths - The env of this settings.

Method Detail

ensureConfigNotNull

protected final void ensureConfigNotNull()

Ensures that the mergedProperties is not null.

get

protected final java.lang.String get(java.lang.String name,
                                     java.lang.String defaultVal)

Gets a setting value by given setting name. If no value found, gets the default value provided.

Parameters:

name - The setting name specified.

defaultVal - The default value.

Returns:

The setting value if exists, otherwise default value.

get

protected final java.lang.String get(java.lang.String name)

Gets a setting value by given setting name. If no value found, empty string will be returned.

Parameters:

name - The setting name specified.

Returns:

The setting value if exists, otherwise empty string.

getClassType

protected abstract java.lang.Class getClassType()

Gets the type of the concrete settings class.

Returns:

The type of the concrete settings class.

getAppConfigFolder

protected abstract java.lang.String getAppConfigFolder()

Gets the settings folder name on resource.

Returns:

The settings folder name.

getString

public final java.lang.String getString(java.lang.String key)

Description copied from interface: Settings

Gets a setting value by given setting name. If no value found, empty string will be returned.

Specified by:

getString in interface Settings

Parameters:

key - The setting name specified.

Returns:

The setting value if exists, otherwise empty string.

getString

public final java.lang.String getString(java.lang.String key,
                                        java.lang.String defaultVal)

Description copied from interface: Settings

Gets a setting value by given setting name. If no value found, gets the default value provided.

Specified by:

getString in interface Settings

Parameters:

key - The setting name specified.

defaultVal - The default value.

Returns:

The setting value if exists, otherwise default value.

getInt

public final java.lang.Integer getInt(java.lang.String key)

Description copied from interface: Settings

Get config setting.

Specified by:

getInt in interface Settings

Parameters:

key - Is the key name.

Returns:

Int config. 0 if not found.

getInt

public final java.lang.Integer getInt(java.lang.String key,
                                      int defaultVal)

Description copied from interface: Settings

Get config setting.

Specified by:

getInt in interface Settings

Parameters:

key - Is the key name.

defaultVal - The default value.

Returns:

Int config. With default.

getBoolean

public final java.lang.Boolean getBoolean(java.lang.String key)

Description copied from interface: Settings

Get config setting.

Specified by:

getBoolean in interface Settings

Parameters:

key - Is the key name.

Returns:

Boolean config. false if not found.

getDouble

public final java.lang.Double getDouble(java.lang.String key)

Description copied from interface: Settings

Get config setting.

Specified by:

getDouble in interface Settings

Parameters:

key - Is the key name.

Returns:

Boolean config. false if not found.

getDouble

public final java.lang.Double getDouble(java.lang.String key,
                                        double defaultVal)

Description copied from interface: Settings

Get config setting.

Specified by:

getDouble in interface Settings

Parameters:

key - Is the key name.

defaultVal - The default value.

Returns:

Boolean config. With default.