org.dlese.dpc.propertiesmgr

Class PropertiesManager

java.lang.Object

java.util.Dictionary<K,V>

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

java.util.Properties

org.dlese.dpc.propertiesmgr.PropertiesManager

All Implemented Interfaces:

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

public class PropertiesManager
extends java.util.Properties

Reads and writes Java properties files. Properties files can be on disc or contained within a Jar file.

Version:

$Id: PropertiesManager.java,v 1.6 2009/03/20 23:33:54 jweather Exp $

Author:

John Weatherley

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
PropertiesManager() Create an unloaded Properties object.
PropertiesManager(java.lang.String propsFileName) Create and load this Properties hash map from the given Properties file or properties resource located in the jar.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getProp(java.lang.String property, java.lang.String defaultValue) Retrieves the property value from this object's property file.
boolean	getPropAsBoolean(java.lang.String property, java.lang.String defaultValue) Same as the getProp(String,String) method only it returns it's parameter as a boolean.
int	getPropAsInt(java.lang.String property, java.lang.String defaultValue) Same as the getProp(String,String) method only it returns it's parameter as an integer.
void	loadPropertiesFile() Loads or re-loads the properties from its file or JAR, replacing all previously loaded properties, if any.
void	writePropsFile() Writes the properties to the same file that was used to read them, preserving any comments in the file.
void	writePropsFile(java.lang.String propsFilePath) Writes the properties to the given file path.

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, 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

PropertiesManager

public PropertiesManager()

Create an unloaded Properties object. Same as Properties().

PropertiesManager

public PropertiesManager(java.lang.String propsFileName)
                  throws java.io.IOException

Create and load this Properties hash map from the given Properties file or properties resource located in the jar.

Parameters:

propsFileName - The name of the Properties file to load or URL to the properties location inside a jar

Throws:

java.io.IOException - If unable to load the properties.

Method Detail

loadPropertiesFile

public void loadPropertiesFile()
                        throws java.io.IOException

Loads or re-loads the properties from its file or JAR, replacing all previously loaded properties, if any. If the file or JAR is not configured, does nothing.

Throws:

java.io.IOException - If error

writePropsFile

public void writePropsFile()
                    throws java.io.IOException

Writes the properties to the same file that was used to read them, preserving any comments in the file. If the original file was contained in a jar then an I/O excetion is thrown.

Throws:

java.io.IOException - If error in input/output

writePropsFile

public void writePropsFile(java.lang.String propsFilePath)
                    throws java.io.IOException

Writes the properties to the given file path. If the file path is the same as the one used to upen this file, then all comments in the file are preserved.

Parameters:

propsFilePath - The full path to the props file to be written.

Throws:

java.io.IOException - If error in input/output

getProp

public java.lang.String getProp(java.lang.String property,
                                java.lang.String defaultValue)
                         throws java.lang.Exception

Retrieves the property value from this object's property file. If the property does not exist and a default value is specified, the default is set in the Properties and is returned.

Parameters:

property - The property sting to retrieve

defaultValue - The default value for this property, if none is found

Returns:

The prop value

Throws:

java.lang.Exception - If error

getPropAsInt

public int getPropAsInt(java.lang.String property,
                        java.lang.String defaultValue)
                 throws java.lang.Exception

Same as the getProp(String,String) method only it returns it's parameter as an integer.

Parameters:

property - The property sting to retrieve

defaultValue - The default value for this property, if none is found

Returns:

The prop value

Throws:

java.lang.Exception - If error

getPropAsBoolean

public boolean getPropAsBoolean(java.lang.String property,
                                java.lang.String defaultValue)
                         throws java.lang.Exception

Same as the getProp(String,String) method only it returns it's parameter as a boolean. Possible inputs are [yes|no|true|false|on|off|enabled|disabled].

Parameters:

property - The property sting to retrieve

defaultValue - The default value for this property, if none is found

Returns:

The prop value

Throws:

java.lang.Exception - If error