Package nl.colorize.util

Class PropertyUtils

java.lang.Object

nl.colorize.util.PropertyUtils

public final class PropertyUtils
extends Object

Utility class for working with Properties and .properties files. Although .properties files are widely used in Java applications, the standard API for working with them is relatively limited. This class adds a number of convenience methods to more easily load .properties from multiple sources, to manipulate Properties instances, and to serialize the results.

Method Summary

Modifier and Type	Method	Description
protected static Properties	emulateLoadProperties(Reader source)	Custom implementation for parsing .properties files.
static Properties	filterPrefix(Properties original, String prefix)	Returns a new Properties object that only includes properties from the original that have a name matching the specified prefix.
static Properties	loadProperties(File source)	Uses the logic described in loadProperties(Reader) to load a .properties file using the UTF-8 character encoding.
static Properties	loadProperties(File source, Charset charset)	Uses the logic described in loadProperties(Reader) to load a .properties file, using the specified character encoding.
static Properties	loadProperties(Reader source)	Parses the contents of a .properties file and returns the resulting Properties object.
static Properties	loadProperties(String contents)	Uses the logic described in loadProperties(Reader) to load .properties file contents from a string.
static Properties	loadProperties(ResourceFile file)	Uses the logic described in loadProperties(Reader) to load a .properties file, using the UTF-8 character encoding.
static Properties	loadProperties(ResourceFile file, Charset charset)	Uses the logic described in loadProperties(Reader) to load a .properties file, using the specified character encoding.
static void	saveProperties(Properties data, File dest)	Uses the logic from saveProperties(Properties, Writer) to serialize a Properties instance to a .properties file.
static void	saveProperties(Properties data, File dest, Charset charset)	Uses the logic from saveProperties(Properties, Writer) to serialize a Properties instance to a .properties file.
static void	saveProperties(Properties data, Writer dest)	Serializes a Properties object to the specified writer.
static String	serializeProperties(Properties data)	Uses the logic from saveProperties(Properties, Writer) to serialize a Properties instance to .properties file contents.
static Map<String,String>	toMap(Properties properties)	Creates a map from a Properties object.
static Properties	toProperties(Map<String,String> data)	Creates a Properties object from a map.

Methods inherited from class java.lang.Object

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

Method Details

loadProperties

public static Properties loadProperties(Reader source)

Parses the contents of a .properties file and returns the resulting Properties object.

This method will use a different implementation depending on the platform. On platforms that do not support the standar Properties.load(Reader), such as TeaVM, a custom implementation is used in order to support UTF-8 property files.

Throws:

ResourceException - if an I/O error occurs while reading the file.

emulateLoadProperties

protected static Properties emulateLoadProperties(Reader source)
                                           throws IOException

Custom implementation for parsing .properties files. See the documentation for loadProperties(Reader) for more information on when and why this is used.

Throws:

IOException

loadProperties

public static Properties loadProperties(ResourceFile file,
 Charset charset)

Uses the logic described in loadProperties(Reader) to load a .properties file, using the specified character encoding.

Throws:

ResourceException - if an I/O error occurs while reading the file.

loadProperties

public static Properties loadProperties(ResourceFile file)

Uses the logic described in loadProperties(Reader) to load a .properties file, using the UTF-8 character encoding.

Throws:

ResourceException - if an I/O error occurs while reading the file.

loadProperties

public static Properties loadProperties(File source,
 Charset charset)
                                 throws IOException

Uses the logic described in loadProperties(Reader) to load a .properties file, using the specified character encoding.

Throws:

IOException - if an I/O error occurs while reading the file.

loadProperties

public static Properties loadProperties(File source)
                                 throws IOException

Uses the logic described in loadProperties(Reader) to load a .properties file using the UTF-8 character encoding.

Throws:

IOException - if an I/O error occurs while reading the file.

loadProperties

public static Properties loadProperties(String contents)

Uses the logic described in loadProperties(Reader) to load .properties file contents from a string.

saveProperties

public static void saveProperties(Properties data,
 Writer dest)
                           throws IOException

Serializes a Properties object to the specified writer. This method differs from the standard Properties.store(Writer, String), in that it writes the properties in a deterministic (alphabetical) order.

Throws:

IOException - if an I/O error occurs while writing.

saveProperties

public static void saveProperties(Properties data,
 File dest,
 Charset charset)
                           throws IOException

Uses the logic from saveProperties(Properties, Writer) to serialize a Properties instance to a .properties file. The file is created using the specified character encoding.

Throws:

IOException - if an I/O error occurs while writing the file.

saveProperties

public static void saveProperties(Properties data,
 File dest)
                           throws IOException

Uses the logic from saveProperties(Properties, Writer) to serialize a Properties instance to a .properties file. The file is created using the UTF-8 character encoding.

Throws:

IOException - if an I/O error occurs while writing the file.

serializeProperties

public static String serializeProperties(Properties data)

Uses the logic from saveProperties(Properties, Writer) to serialize a Properties instance to .properties file contents.

toProperties

public static Properties toProperties(Map<String,String> data)

Creates a Properties object from a map. Any null keys and/or values in the map will not be registered as properties.

toMap

public static Map<String,String> toMap(Properties properties)

Creates a map from a Properties object. Any null or empty property values will not be included in the map.

filterPrefix

public static Properties filterPrefix(Properties original,
 String prefix)

Returns a new Properties object that only includes properties from the original that have a name matching the specified prefix.

The property names in the result instance will have the prefix removed from their name. For example, if the original included a property "a.x", and the prefix is "a.", the result will include a property named "x".

Throws:

IllegalArgumentException - if the provided prefix is empty.