be.SIRAPRISE.util

Class MyProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

be.SIRAPRISE.util.MyProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

Direct Known Subclasses:

ClientSideTypeImplementationsManagerProperties, DBConnectionPoolProperties, DBConnectionProperties, DBMonitorConnectionProperties, DBObjectGeneratorProperties, DBObjectInterfaceGeneratorProperties, MyPropertiesInInsertionOrder, OperatorImplementationsManagerProperties, ProcessScriptProperties, ServerEngineProperties, TypeImplementationsManagerProperties

public abstract class MyProperties
extends java.util.Properties

Author:

Erwin

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MyProperties.SKIPAUTOLOAD

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SUFFIX

Constructor Summary

Constructors

Constructor and Description
MyProperties()
MyProperties(boolean resolveSystemPropertyReferences) Creates the Properties object, and tries to load it from one of the following places: A resource available to this' classloader A file in the directory pointed to by the user.dir system property A file in the directory pointed to by the user.home system property
MyProperties(MyProperties.SKIPAUTOLOAD skipAutoLoad) Constructor that skips the automatic loading process.
MyProperties(java.util.Properties defaults) Creates the MyProperties
MyProperties(java.util.Properties defaults, boolean resolveSystemPropertyReferences) Creates the MyProperties

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getOptionalProperty(java.util.Properties properties, java.lang.String key) Gets the named property value from the given Properties object.
java.lang.String	getOptionalProperty(java.lang.String key) Gets the named property value from the given Properties object.
static java.lang.String	getPropertiesBaseName(java.lang.Class<? extends java.util.Properties> propertiesClass) Gets the base name for the properties resource corresponding to the given class.
static java.lang.String	getRequiredProperty(java.util.Properties properties, java.lang.String key) Gets the named property value from the given Properties object.
java.lang.String	getRequiredProperty(java.lang.String key) Gets the named property value from the given Properties object.
static java.lang.String	resolveSystemPropertyRefs(java.lang.String propertyValue) Resolves any references to System Properties in a String value by replacing the reference with the actual System Property value.

Methods inherited from class java.util.Properties

getProperty, 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, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SUFFIX

public static final java.lang.String SUFFIX

See Also:

Constant Field Values

Constructor Detail

MyProperties

public MyProperties()

MyProperties

public MyProperties(boolean resolveSystemPropertyReferences)

Creates the Properties object, and tries to load it from one of the following places:

1. A resource available to this' classloader
2. A file in the directory pointed to by the user.dir system property
3. A file in the directory pointed to by the user.home system property

Parameters:

resolveSystemPropertyReferences - flag to indicate whether System property references (e.g.${user.home}) are to be resolved when loading the properties

MyProperties

public MyProperties(java.util.Properties defaults)

Creates the MyProperties

Parameters:

defaults - -

MyProperties

public MyProperties(java.util.Properties defaults,
                    boolean resolveSystemPropertyReferences)

Creates the MyProperties

Parameters:

defaults - -

resolveSystemPropertyReferences - flag to indicate whether System property references (e.g.${user.home}) are to be resolved when loading the properties

MyProperties

public MyProperties(MyProperties.SKIPAUTOLOAD skipAutoLoad)

Constructor that skips the automatic loading process.

Parameters:

skipAutoLoad - not used, except to distinguish this constructor from others

Method Detail

getOptionalProperty

public static java.lang.String getOptionalProperty(java.util.Properties properties,
                                                   java.lang.String key)
                                            throws NotFoundException

Gets the named property value from the given Properties object. If the property is not present (no value is mapped to the key), a NotFoundException is thrown.

Parameters:

properties - The Properties from which to return the value mapped to the named key

key - The key whose mapped value is to be returned

Returns:

The value mapped to the given key value in the given Properties object

Throws:

NotFoundException - If the given key value has no mapping in the given Properties

getPropertiesBaseName

public static java.lang.String getPropertiesBaseName(java.lang.Class<? extends java.util.Properties> propertiesClass)

Gets the base name for the properties resource corresponding to the given class. This is as follows (first rule that applies) :

1. full classname does not end with 'PROPERTIES' (case insensitive) ===> full classname, suffixed with '.properties' (e.g. "com.foo.Bar.properties")
2. full classname ends with '.PROPERTIES', or is equal to 'PROPERTIES' (both case insensitive) ===> full classname (e.g. "com.foo.properties", or just "properties")
3. full classname ends with 'PROPERTIES', not preceded by a dot (i.e. X.Y.ZPROPERTIES) ===> X.Y.Z, suffixed with '.properties' (e.g. "com.foo.Bar.properties")

Parameters:

propertiesClass - the class for which the corresponding properties resource name is to be returned

Returns:

the base name for the properties resource corresponding to the given class.

getRequiredProperty

public static java.lang.String getRequiredProperty(java.util.Properties properties,
                                                   java.lang.String key)

Gets the named property value from the given Properties object. If the property is not present (no value is mapped to the key), a NotFoundException is thrown.

Parameters:

properties - The properties

key - The key name of the required property to be obtained

Returns:

The value mapped to the given key value in the given Properties object

resolveSystemPropertyRefs

public static java.lang.String resolveSystemPropertyRefs(java.lang.String propertyValue)

Resolves any references to System Properties in a String value by replacing the reference with the actual System Property value. System Property references appear as a ${} sequence with the property name in between. They cannot be nested, i.e. the name of the property cannot be itself the result of resolving a nested property reference.

Parameters:

propertyValue - The String value to be resolved for System Property references

Returns:

The resolved String value

getOptionalProperty

public final java.lang.String getOptionalProperty(java.lang.String key)
                                           throws NotFoundException

Gets the named property value from the given Properties object. If the property is not present (no value is mapped to the key), a NotFoundException is thrown.

Parameters:

key - The key whose mapped value is to be returned

Returns:

The value mapped to the given key value in the given Properties object

Throws:

NotFoundException - If the given key value has no mapping in the given Properties

getRequiredProperty

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

Gets the named property value from the given Properties object. If the property is not present (no value is mapped to the key), a NotFoundException is thrown.

Parameters:

key - The key name of the required property to be obtained

Returns:

The value mapped to the given key value in the given Properties object