com.adaptris.core.util

Class PropertyHelper

java.lang.Object

com.adaptris.core.util.PropertyHelper

public class PropertyHelper
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PropertyHelper.PropertyInputStream

Constructor Summary

Constructors

Constructor and Description
PropertyHelper()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.String>	asMap(java.util.Properties p) Convenience method to turn a Properties into a Map
static java.lang.String	getPropertyIgnoringCase(java.util.Properties p, java.lang.String key)
static java.lang.String	getPropertyIgnoringCase(java.util.Properties p, java.lang.String key, java.lang.String defaultValue) Convenience method to get a property value ignoring the case.
static java.util.Properties	getPropertySubset(java.util.Properties p, java.lang.String prefix) Get a subset of the configuration properties.
static java.util.Properties	getPropertySubset(java.util.Properties p, java.lang.String prefix, boolean ignoreCase) Get a subset of the configuration properties.
static java.util.Properties	load(PropertyHelper.PropertyInputStream e) Convenience method to load a set of properties from an InputStream
static java.util.Properties	loadQuietly(java.lang.ClassLoader cl, java.lang.String resource) Convenience method to load a set of properties from a resource on the classpath.
static java.util.Properties	loadQuietly(java.io.File file) Convenience method to load a set of properties from a file.
static java.util.Properties	loadQuietly(java.io.InputStream in) Convenience method to load a set of properties from an InputStream
static java.util.Properties	loadQuietly(PropertyHelper.PropertyInputStream e) Convenience method to load a set of properties from an InputStream
static java.util.Properties	loadQuietly(java.lang.String resource) Convenience method to load a set of properties from a resource on the classpath.
static java.util.Properties	loadQuietly(java.net.URL resource) Convenience method to load a set of properties from a URL

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyHelper

public PropertyHelper()

Method Detail

getPropertySubset

public static java.util.Properties getPropertySubset(java.util.Properties p,
                                                     java.lang.String prefix)

Get a subset of the configuration properties.

Parameters:

prefix - the key that must exist in the property key for it to belong.

p - the properties

Returns:

a Properties object containing matching keys and values.

getPropertySubset

public static java.util.Properties getPropertySubset(java.util.Properties p,
                                                     java.lang.String prefix,
                                                     boolean ignoreCase)

Get a subset of the configuration properties.

Parameters:

prefix - the key that must exist in the property key for it to belong.

p - the properties

ignoreCase - whether or not to ignore the case of the prefix and property key

Returns:

a Properties object containing matching keys and values.

getPropertyIgnoringCase

public static java.lang.String getPropertyIgnoringCase(java.util.Properties p,
                                                       java.lang.String key,
                                                       java.lang.String defaultValue)

Convenience method to get a property value ignoring the case.

While we could legitimately override the get/set/getProperty/setProperty methods and convert all the keys to a single case; this would not be appropriate for the properties that we will convert into system properties. So we have a static method to iterate through all the keys of the property doing a case insensitive match. It's not terribly performant, but performance isn't a consideration at this point.

Parameters:

p - the properties you want to query.

key - the key

defaultValue - the default value if key is not matched.

Returns:

the property value.

asMap

public static java.util.Map<java.lang.String,java.lang.String> asMap(java.util.Properties p)

Convenience method to turn a Properties into a Map

Parameters:

p - the properties, if null, will return an empty map

Returns:

a map

getPropertyIgnoringCase

public static java.lang.String getPropertyIgnoringCase(java.util.Properties p,
                                                       java.lang.String key)

See Also:

getPropertyIgnoringCase(Properties, String, String)

loadQuietly

public static java.util.Properties loadQuietly(java.io.File file)

Convenience method to load a set of properties from a file.

Parameters:

file - the file.

Returns:

a possibly empty set of properties.

loadQuietly

public static java.util.Properties loadQuietly(java.lang.String resource)

Convenience method to load a set of properties from a resource on the classpath.

Parameters:

resource - the resource that will be found via Thread.currentThread().getContextClassLoader().getResourceAsStream(String).

Returns:

a possibly empty set of properties.

loadQuietly

public static java.util.Properties loadQuietly(java.lang.ClassLoader cl,
                                               java.lang.String resource)

Convenience method to load a set of properties from a resource on the classpath.

Parameters:

cl - the classloader.

resource - the resource that will be found via ClassLoader#getResourceAsStream(String).

Returns:

a possibly empty set of properties.

loadQuietly

public static java.util.Properties loadQuietly(java.net.URL resource)

Convenience method to load a set of properties from a URL

Parameters:

resource - the resource

Returns:

a possibly empty set of properties.

loadQuietly

public static java.util.Properties loadQuietly(java.io.InputStream in)

Convenience method to load a set of properties from an InputStream

Parameters:

in - the inputstream

Returns:

a possibly empty set of properties.

loadQuietly

public static java.util.Properties loadQuietly(PropertyHelper.PropertyInputStream e)

Convenience method to load a set of properties from an InputStream

Parameters:

e - the PropertyHelper.PropertyInputStream instance (probably a lambda expression).

Returns:

a possibly empty set of properties.

load

public static java.util.Properties load(PropertyHelper.PropertyInputStream e)
                                 throws java.io.IOException

Convenience method to load a set of properties from an InputStream

Parameters:

e - the PropertyHelper.PropertyInputStream instance (probably a lambda expression).

Returns:

the properties loaded from the input stream.

Throws:

java.io.IOException - any IO exceptions reading the input stream.