au.gov.nehta.common.utils

Class PropertyUtils

java.lang.Object

au.gov.nehta.common.utils.PropertyUtils

public final class PropertyUtils
extends Object

Static class used to manage access to System properties.

Method Summary

Modifier and Type	Method and Description
static boolean	getBooleanProperty(Properties properties, String name, boolean defaultValue) Retrieves a property value as a boolean.
static String	getSystemProperty(String name) Gets the value of the system property with the given name, throwing an exception if the system property is not set.
static String	getSystemProperty(String name, String defaultValue) Gets the value of the system property with the given name, returning a default value if the system property is not set.
static Properties	loadProperties(File file) Load the properties from the given file.
static Properties	loadProperties(InputStream inputStream) Load the properties from a byte stream.
static Properties	loadProperties(Reader reader) Load the properties from a character stream.
static void	setSystemProperty(String name, String value) Sets a system property with a given name.

Methods inherited from class java.lang.Object

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

Method Detail

getSystemProperty

public static String getSystemProperty(String name)

Gets the value of the system property with the given name, throwing an exception if the system property is not set.

Parameters:

name - Name of the system property. Cannot be null nor a blank string.

Returns:

The value of the system property.

Throws:

IllegalArgumentException - if not found.

getSystemProperty

public static String getSystemProperty(String name,
                                       String defaultValue)

Gets the value of the system property with the given name, returning a default value if the system property is not set.

Parameters:

name - Name of the system property. Cannot be null nor a blank string.

defaultValue - Default value.

Returns:

If found, the value of the system property, else the default value.

setSystemProperty

public static void setSystemProperty(String name,
                                     String value)

Sets a system property with a given name.

Parameters:

name - Name of the system property. Cannot be null nor a blank string.

value - Value of the system property. Cannot be null nor a blank string.

loadProperties

public static Properties loadProperties(File file)
                                 throws FileNotFoundException,
                                        IOException

Load the properties from the given file.

Parameters:

file - Path to properties file.

Returns:

The properties loaded from the properties file.

Throws:

FileNotFoundException - Thrown when the properties files doesn't exist.

IOException - Thrown when IO error occurred reading in the properties.

loadProperties

public static Properties loadProperties(Reader reader)
                                 throws IOException

Load the properties from a character stream.

Parameters:

reader - Character stream containing the properties values. Cannot be null.

Returns:

The properties loaded.

Throws:

IOException - Thrown when IO error occurred reading in the properties.

loadProperties

public static Properties loadProperties(InputStream inputStream)
                                 throws IOException

Load the properties from a byte stream.

Parameters:

inputStream - Byte stream containing the properties values. Cannot be null.

Returns:

The properties loaded.

Throws:

IOException - Thrown when IO error occurred reading in the properties.

getBooleanProperty

public static boolean getBooleanProperty(Properties properties,
                                         String name,
                                         boolean defaultValue)

Retrieves a property value as a boolean. The string property values that is returned as a true boolean value are: "true", "yes", "on" and "1". Comparisons are case insensitive.

Parameters:

properties - Properties object to inspect. Cannot be null.

name - Name of the property. Cannot be null nor a blank string.

defaultValue - Boolean value to return if the property is not set.

Returns:

boolean property value.