com.communote.common.properties

Class PropertiesUtils

java.lang.Object

com.communote.common.properties.PropertiesUtils

public final class PropertiesUtils
extends Object

Helper class for working with Properties

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static Properties	load(String resourceName) Load properties from the given resources using the current thread context class loader.
static Properties	load(String resourceName, ClassLoader loader) Load properties from the given resources using the given class loader.
static Properties	load(URL url) Load properties from the given URL.
static Properties	loadPropertiesFromFile(File propertiesFile) Load the properties from a file.
static Properties	loadPropertiesFromFile(String propertiesFileName) Load the properties from a file.
static void	storePropertiesToFile(Properties properties, File propertiesFile) Stores the properties in a file.
static void	storePropertiesToFile(Properties properties, File propertiesFile, Charset charset) Stores the properties in a file.

Methods inherited from class java.lang.Object

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

Method Detail

load

public static Properties load(String resourceName)
                       throws IOException

Load properties from the given resources using the current thread context class loader. The properties are expected to be encoded in UTF-8.

Parameters:

resourceName - The resource name

Returns:

The loaded properties, or null if the resource could not be found

Throws:

IOException - in case an error occurred while reading the properties

load

public static Properties load(String resourceName,
                              ClassLoader loader)
                       throws IOException

Load properties from the given resources using the given class loader. The properties are expected to be encoded in UTF-8.

Parameters:

resourceName - The resource name

loader - The class loader

Returns:

The loaded properties, or null if the resource could not be found

Throws:

IOException - in case an error occurred while reading the properties

load

public static Properties load(URL url)
                       throws IOException

Load properties from the given URL. The properties are expected to be UTF-8 encoded.

Note: this method does not set a read timeout!

Parameters:

url - the URL to load from

Returns:

The loaded properties

Throws:

IOException - in case an error occurred while reading the properties

loadPropertiesFromFile

public static Properties loadPropertiesFromFile(File propertiesFile)
                                         throws IOException

Load the properties from a file. The properties are expected to be UTF-8 encoded.

Parameters:

propertiesFile - The property file

Returns:

The loaded properties

Throws:

IOException - if the file cannot be found or read

loadPropertiesFromFile

public static Properties loadPropertiesFromFile(String propertiesFileName)
                                         throws IOException

Load the properties from a file. The properties are expected to be UTF-8 encoded.

Parameters:

propertiesFileName - The name of the property file

Returns:

The loaded properties

Throws:

IOException - if the file cannot be found or read

storePropertiesToFile

public static void storePropertiesToFile(Properties properties,
                                         File propertiesFile)
                                  throws IOException

Stores the properties in a file. The properties are written with UTF-8 encoding.

Parameters:

properties - the properties to store

propertiesFile - The property file

Throws:

IOException - if the file cannot be found or written

storePropertiesToFile

public static void storePropertiesToFile(Properties properties,
                                         File propertiesFile,
                                         Charset charset)
                                  throws IOException

Stores the properties in a file.

Parameters:

properties - the properties to store

propertiesFile - The property file

charset - charset to use for encoding the output

Throws:

IOException - if the file cannot be found or written