nl.nn.adapterframework.util

Class PropertyLoader

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

nl.nn.adapterframework.util.PropertyLoader

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

Direct Known Subclasses:

AppConstants, CredentialConstants

public class PropertyLoader
extends Properties

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
PropertyLoader(ClassLoader classLoader, String propertiesFile)
PropertyLoader(String propertiesFile)

Method Summary

Modifier and Type	Method and Description
String	get(Object key)
boolean	getBoolean(String key, boolean dfault) Gets a boolean value Returns "true" if the retrieved value is "true", otherwise "false" Uses the getResolvedProperty(String) method.
double	getDouble(String key, double dfault) Gets a double value Uses the getResolvedProperty(String) method.
int	getInt(String key, int dfault) Gets an int value Uses the getResolvedProperty(String) method.
List<String>	getListProperty(String key) Retrieves a list property value associated with the specified key.
List<String>	getListProperty(String key, String defaults) Retrieves a list property value associated with the specified key.
long	getLong(String key, long dfault) Gets a long value Uses the getResolvedProperty(String) method.
String	getProperty(String key)
protected String	getResolvedProperty(String key) the method is like the Properties.getProperty, but provides functionality to resolve ${variable} Syntaxes.
String	getString(String key, String dfault) Gets a String value Uses the getResolvedProperty(String) method.
String	getUnresolvedProperty(String key)
protected void	load(ClassLoader classLoader, String filename) Load the contents of a properties file.
Object	put(Object key, Object value) Deprecated. Use Properties.setProperty(String, String) instead!

Methods inherited from class java.util.Properties

getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keys, keySet, merge, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertyLoader

public PropertyLoader(String propertiesFile)

PropertyLoader

public PropertyLoader(ClassLoader classLoader,
                      String propertiesFile)

Method Detail

get

public String get(Object key)

Specified by:

get in interface Map<Object,Object>

Overrides:

get in class Hashtable<Object,Object>

getProperty

public String getProperty(String key)

Overrides:

getProperty in class Properties

getUnresolvedProperty

public String getUnresolvedProperty(String key)

getResolvedProperty

protected final String getResolvedProperty(String key)

the method is like the Properties.getProperty, but provides functionality to resolve ${variable} Syntaxes. It uses the property values and system values to resolve the variables, and does so recursively.

See Also:

StringResolver

getListProperty

@Nonnull
public List<String> getListProperty(@Nonnull
                                             String key)

Retrieves a list property value associated with the specified key. The method first resolves the property value using the getResolvedProperty(String) method. If the resolved property value is null, an empty list is returned.

Parameters:

key - the key of the property value to retrieve

Returns:

a list of string values associated with the specified key, or an empty list if the resolved property is null

getListProperty

@Nonnull
public List<String> getListProperty(@Nonnull
                                             String key,
                                             @Nullable
                                             String defaults)

Retrieves a list property value associated with the specified key. The method first resolves the property value using the getResolvedProperty(String) method. If the resolved property value is null, it returns the list of string values provided as "defaults".

Parameters:

key - the key of the property value to retrieve

defaults - the default list of string values to return if the resolved property is null

Returns:

a list of string values associated with the specified key, or the default list if the resolved property is null. If the defaults is also null, then returns an empty list.

put

@Deprecated
public Object put(Object key,
                              Object value)

Deprecated. Use Properties.setProperty(String, String) instead!

Add property only in the local PropertyLoader! Do not use this method and use Properties.setProperty(String, String) if you want to set the property globally!

This method is used by Properties.load(InputStream) to add all properties found (in a file/stream) to the underlying Hashtable.

Specified by:

put in interface Map<Object,Object>

Overrides:

put in class Hashtable<Object,Object>

load

protected void load(ClassLoader classLoader,
                    String filename)

Load the contents of a properties file.

Optionally, this may be a comma-separated list of files to load, e.g.

log4j2.properties,DeploymentSpecifics.properties

which will cause both files to be loaded in the listed order.

getString

public String getString(String key,
                        String dfault)

Gets a String value Uses the getResolvedProperty(String) method.

Parameters:

key - the Key

dfault - the default value

Returns:

String

getBoolean

public boolean getBoolean(String key,
                          boolean dfault)

Gets a boolean value Returns "true" if the retrieved value is "true", otherwise "false" Uses the getResolvedProperty(String) method.

Parameters:

key - the Key

dfault - the default value

Returns:

double

getInt

public int getInt(String key,
                  int dfault)

Gets an int value Uses the getResolvedProperty(String) method.

Parameters:

key - the Key

dfault - the default value

Returns:

int

getLong

public long getLong(String key,
                    long dfault)

Gets a long value Uses the getResolvedProperty(String) method.

Parameters:

key - the Key

dfault - the default value

Returns:

long

getDouble

public double getDouble(String key,
                        double dfault)

Gets a double value Uses the getResolvedProperty(String) method.

Parameters:

key - the Key

dfault - the default value

Returns:

double