org.jrebirth.af.core.resource.parameter

Class ParameterBuilder

java.lang.Object

org.jrebirth.af.core.resource.builder.AbstractResourceBuilder<ParameterItem<?>,ParameterParams,Object>

org.jrebirth.af.core.resource.parameter.ParameterBuilder

All Implemented Interfaces:

ResourceBuilder<ParameterItem<?>,ParameterParams,Object>, MessageContainer, ParameterMessages

public final class ParameterBuilder
extends AbstractResourceBuilder<ParameterItem<?>,ParameterParams,Object>
implements ParameterMessages

The class ParameterBuilder. Class used to manage parameters with weak reference.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private String	configurationFileExtension The file extension used by configuration files.
private String	configurationFileWildcard The Wildcard used to load configuration files.
private static Pattern	ENV_VAR_PATTERN1 The pattern that matches Environment Variable ${varname} .
private static Pattern	ENV_VAR_PATTERN2 The pattern that matches Environment Variable $varname .
private static JRLogger	LOGGER The class logger.
private Map<ParameterItem<?>,Object>	overriddenParametersMap Store all overridden values defined by the call of define method.
private Map<String,ParameterEntry>	propertiesParametersMap Store all parameter values defined into properties files.
private Map<String,String>	varenvMap Store all translated environment variable.

Fields inherited from interface org.jrebirth.af.core.resource.parameter.ParameterMessages

CONF_READING_ERROR, CONFIG_FOUND, READ_CONF_FILE, SKIP_CONF_LOADING, STORE_PARAMETER, UNDEFINED_ENV_VAR, UPDATE_PARAMETER

Constructor Summary

Constructors

Constructor and Description
ParameterBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	buildResource(ParameterItem<?> parameterItem, ParameterParams parameterParams) Build the resource requested.
private String	checkPattern(String value, Pattern pattern, boolean withBrace) Check if the given string contains an environment variable.
void	define(ParameterItem<?> key, Object forcedValue) Override a parameter value.
private void	readPropertiesFile(String custConfFileName) Read a customized configuration file to load parameters values.
private void	readPropertiesFiles() Read all configuration files available into the application classpath.
private String	resolveVarEnv(String entryValue) Resolve any environment variable found into the string.
void	searchConfigurationFiles(String wildcard, String extension) Search configuration files according to the parameters provided.
private void	storePropertiesParameter(Map.Entry<Object,Object> entry) Store a parameter read from properties files.

Methods inherited from class org.jrebirth.af.core.resource.builder.AbstractResourceBuilder

get, getParam, getParamKey, set, storeParams

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final JRLogger LOGGER

The class logger.

ENV_VAR_PATTERN1

private static final Pattern ENV_VAR_PATTERN1

The pattern that matches Environment Variable ${varname} .

ENV_VAR_PATTERN2

private static final Pattern ENV_VAR_PATTERN2

The pattern that matches Environment Variable $varname .

propertiesParametersMap

private final Map<String,ParameterEntry> propertiesParametersMap

Store all parameter values defined into properties files.

overriddenParametersMap

private final Map<ParameterItem<?>,Object> overriddenParametersMap

Store all overridden values defined by the call of define method.

varenvMap

private final Map<String,String> varenvMap

Store all translated environment variable.

configurationFileExtension

private String configurationFileExtension

The file extension used by configuration files.

configurationFileWildcard

private String configurationFileWildcard

The Wildcard used to load configuration files.

Constructor Detail

ParameterBuilder

public ParameterBuilder()

Method Detail

searchConfigurationFiles

public void searchConfigurationFiles(String wildcard,
                            String extension)

Search configuration files according to the parameters provided.

Parameters:

wildcard - the regex wildcard (must not be null)

extension - the file extension without the first dot (ie: properties) (must not be null)

readPropertiesFiles

private void readPropertiesFiles()

Read all configuration files available into the application classpath.

readPropertiesFile

private void readPropertiesFile(String custConfFileName)

Read a customized configuration file to load parameters values.

Parameters:

custConfFileName - the file to load

storePropertiesParameter

private void storePropertiesParameter(Map.Entry<Object,Object> entry)

Store a parameter read from properties files.
The parameter is wrapped into a parameterEntry

Parameters:

entry - the entry to store

resolveVarEnv

private String resolveVarEnv(String entryValue)

Resolve any environment variable found into the string.

Parameters:

entryValue - the string to check and resolve

Returns:

the final value with environment variable resolved

checkPattern

private String checkPattern(String value,
                  Pattern pattern,
                  boolean withBrace)

Check if the given string contains an environment variable.

Parameters:

value - the string value to parse

pattern - the regex pattern to use

withBrace - true for ${varname}, false for $varname

Returns:

the given string updated with right environment variable content

buildResource

protected Object buildResource(ParameterItem<?> parameterItem,
                   ParameterParams parameterParams)

Build the resource requested.

Specified by:

buildResource in class AbstractResourceBuilder<ParameterItem<?>,ParameterParams,Object>

Parameters:

parameterItem - the parameter item used to identify the resource element

parameterParams - the primitive parameters used to build the resource

Returns:

the resource built and weakly stored with a WeakReference

define

public void define(ParameterItem<?> key,
          Object forcedValue)

Override a parameter value.

Parameters:

key - the parameter item key

forcedValue - the overridden value