com.databasesandlife.util

Class PropertiesUtil

java.lang.Object

com.databasesandlife.util.PropertiesUtil

public class PropertiesUtil
extends Object

Utility class for manipulating Properties objects, as if they were hierarchical objects. Lists can be created with .0. .1., etc, and key/value pairs can also be constructed.

Author:

This source is copyright Adrian Smith and licensed under the LGPL 3.

See Also:

Project on GitHub

Constructor Summary

Constructors

Constructor and Description
PropertiesUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	existsSubProperties(Properties p, String prefix) Determines if getSubProperties would return an empty Properties or not.
static Properties	getCachedPropertiesForResourceName(String name)
static String	getPropertyOrThrow(Properties p, String key)
static String	getPropertyOrThrow(String resourceBundleName, String key)
static Properties	getSubProperties(Properties p, String prefix) Takes a Properties with keys such as "rules.x" and "y", and a prefix string such as "rules" and returns a new Properties with keys such as "x".
static Properties	newPropertiesForClass(Class<?> c)
static Properties	newPropertiesForResourceBundle(ResourceBundle b) Takes a ResourceBundle (describing keys/values) and converts the object into a Properties object.
static Properties	newPropertiesForResourceName(String resourceBundleName)
static Properties	prefixAllProperties(Properties p, String prefix) Takes a properties and prefixes all entries with prefix and a dot
static Properties[]	splitToArray(Properties p, String prefix) Takes a prefix like "rules" and then finds "rules.0.x" etc, puts them into lots of Properties objects with keys like "x" and position 0 in the array.
static Hashtable<String,Properties>	splitToHashtable(Properties p, String prefix) Deprecated. use splitToMap(Properties,String)
static Map<String,Properties>	splitToMap(Properties p, String prefix) Takes a prefix like "rules" and then finds "rules.name.key", puts them in a Map.
static Vector<Properties>	splitToVector(Properties p, String prefix) Deprecated. use splitToArray instead, this provides type-safety
static Properties	union(Properties p1, Properties p2) Creates a new Properties which is the combination of all the keys in p1 and p2.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesUtil

public PropertiesUtil()

Method Detail

splitToVector

public static Vector<Properties> splitToVector(Properties p,
                                               String prefix)

Deprecated. use splitToArray instead, this provides type-safety

Same as splitToArray but returns a Vector.

See Also:

splitToArray(java.util.Properties, java.lang.String)

splitToArray

public static Properties[] splitToArray(Properties p,
                                        String prefix)

Takes a prefix like "rules" and then finds "rules.0.x" etc, puts them into lots of Properties objects with keys like "x" and position 0 in the array. If prefix is "" then finds "0.x" etc.

Returns:

a Vector of Properties objects

See Also:

splitToVector(java.util.Properties, java.lang.String)

splitToHashtable

public static Hashtable<String,Properties> splitToHashtable(Properties p,
                                                            String prefix)

Deprecated. use splitToMap(Properties,String)

Takes a prefix like "rules" and then finds "rules.name.key", puts them in a Hashtable of Property objects, where they keys are the strings like "name", and the values are Properties objects, from "key" to value. If prefix is "" then finds "name.key" etc.

Returns:

a Hashtable from String objects to Properties objects

splitToMap

public static Map<String,Properties> splitToMap(Properties p,
                                                String prefix)

Takes a prefix like "rules" and then finds "rules.name.key", puts them in a Map. The keys are strings like "name", and the values are Properties objects, from "key" to value. If prefix is "" then finds "name.key" etc.

getSubProperties

public static Properties getSubProperties(Properties p,
                                          String prefix)

Takes a Properties with keys such as "rules.x" and "y", and a prefix string such as "rules" and returns a new Properties with keys such as "x".

existsSubProperties

public static boolean existsSubProperties(Properties p,
                                          String prefix)

Determines if getSubProperties would return an empty Properties or not. (But it's faster than calling getSubProperties)

See Also:

getSubProperties(java.util.Properties, java.lang.String)

prefixAllProperties

public static Properties prefixAllProperties(Properties p,
                                             String prefix)

Takes a properties and prefixes all entries with prefix and a dot

union

public static Properties union(Properties p1,
                               Properties p2)

Creates a new Properties which is the combination of all the keys in p1 and p2. If the same key exists in both preoperties, the behaviour is undefined.

newPropertiesForResourceBundle

public static Properties newPropertiesForResourceBundle(ResourceBundle b)

Takes a ResourceBundle (describing keys/values) and converts the object into a Properties object.

newPropertiesForResourceName

public static Properties newPropertiesForResourceName(String resourceBundleName)
                                               throws MissingResourceException

Parameters:

resourceBundleName - name for example "com.ucpag.components.x" where there is a properties file called "x.properties" in the appropriate directory, and returns a Properties object for that file.

Throws:

MissingResourceException - if file cannot be found

newPropertiesForClass

public static Properties newPropertiesForClass(Class<?> c)

getCachedPropertiesForResourceName

public static Properties getCachedPropertiesForResourceName(String name)
                                                     throws MissingResourceException

Parameters:

name - name for example "com.ucpag.components.x" where there is a properties file called "x.properties" in the appropriate directory, and returns a Properties object for that file.

Throws:

MissingResourceException - if file cannot be found

getPropertyOrThrow

public static String getPropertyOrThrow(Properties p,
                                        String key)

getPropertyOrThrow

public static String getPropertyOrThrow(String resourceBundleName,
                                        String key)

Parameters:

resourceBundleName - name for example "com.databasesandlife.x" where there is a properties file called "x.properties" in the appropriate directory, and returns a Properties object for that file.