org.hibernate.util
Class PropertiesHelper

java.lang.Object
  org.hibernate.util.PropertiesHelper

public final class PropertiesHelper
extends java.lang.Object

Collection of helper methods for dealing with Properties objects.

Author:

Gavin King, Steve Ebersole

getString

public static java.lang.String getString(java.lang.String propertyName,
                                         java.util.Properties properties,
                                         java.lang.String defaultValue)

Get a property value as a string.

Parameters:

propertyName - The name of the property for which to retrieve value

properties - The properties object

defaultValue - The default property value to use.

Returns:

The property value; may be null.

See Also:

extractPropertyValue(String, java.util.Properties)

extractPropertyValue

public static java.lang.String extractPropertyValue(java.lang.String propertyName,
                                                    java.util.Properties properties)

Extract a property value by name from the given properties object.

Both null and empty string are viewed as the same, and return null.

Parameters:

propertyName - The name of the property for which to extract value

properties - The properties object

Returns:

The property value; may be null.

getBoolean

public static boolean getBoolean(java.lang.String propertyName,
                                 java.util.Properties properties)

Get a property value as a boolean. Shorthand for calling getBoolean(String, java.util.Properties, boolean) with false as the default value.

Parameters:

propertyName - The name of the property for which to retrieve value

properties - The properties object

Returns:

The property value.

getBoolean

public static boolean getBoolean(java.lang.String propertyName,
                                 java.util.Properties properties,
                                 boolean defaultValue)

Get a property value as a boolean.

First, the string value is extracted, and then Boolean.valueOf(String) is used to determine the correct boolean value.

Parameters:

propertyName - The name of the property for which to retrieve value

properties - The properties object

defaultValue - The default property value to use.

Returns:

The property value.

See Also:

extractPropertyValue(String, java.util.Properties)

getInt

public static int getInt(java.lang.String propertyName,
                         java.util.Properties properties,
                         int defaultValue)

Get a property value as an int.

First, the string value is extracted, and then Integer.parseInt(String) is used to determine the correct int value for any non-null property values.

Parameters:

propertyName - The name of the property for which to retrieve value

properties - The properties object

defaultValue - The default property value to use.

Returns:

The property value.

See Also:

extractPropertyValue(String, java.util.Properties)

getInteger

public static java.lang.Integer getInteger(java.lang.String propertyName,
                                           java.util.Properties properties)

Get a property value as an Integer.

First, the string value is extracted, and then Integer.valueOf(String) is used to determine the correct boolean value for any non-null property values.

Parameters:

propertyName - The name of the property for which to retrieve value

properties - The properties object

Returns:

The property value; may be null.

See Also:

extractPropertyValue(String, java.util.Properties)

toMap

public static java.util.Map toMap(java.lang.String propertyName,
                                  java.lang.String delim,
                                  java.util.Properties properties)

Constructs a map from a property value.

The exact behavior here is largely dependant upon what is passed in as the delimiter.

Parameters:

propertyName - The name of the property for which to retrieve value

delim - The string defining tokens used as both entry and key/value delimiters.

properties - The properties object

Returns:

The resulting map; never null, though perhaps empty.

See Also:

extractPropertyValue(String, java.util.Properties)

toStringArray

public static java.lang.String[] toStringArray(java.lang.String propertyName,
                                               java.lang.String delim,
                                               java.util.Properties properties)

Get a property value as a string array.

Parameters:

propertyName - The name of the property for which to retrieve value

delim - The delimiter used to separate individual array elements.

properties - The properties object

Returns:

The array; never null, though may be empty.

See Also:

extractPropertyValue(String, java.util.Properties), toStringArray(String, String)

toStringArray

public static java.lang.String[] toStringArray(java.lang.String stringForm,
                                               java.lang.String delim)

Convert a string to an array of strings. The assumption is that the individual array elements are delimited in the source stringForm param by the delim param.

Parameters:

stringForm - The string form of the string array.

delim - The delimiter used to separate individual array elements.

Returns:

The array; never null, though may be empty.

maskOut

public static java.util.Properties maskOut(java.util.Properties props,
                                           java.lang.String key)

replace a property by a starred version

Parameters:

props - properties to check

key - proeprty to mask

Returns:

cloned and masked properties

resolvePlaceHolders

public static void resolvePlaceHolders(java.util.Properties properties)

Handles interpolation processing for all entries in a properties object.

Parameters:

properties - The properties object.

resolvePlaceHolder

public static java.lang.String resolvePlaceHolder(java.lang.String property)

Handles interpolation processing for a single property.

Parameters:

property - The property value to be processed for interpolation.

Returns:

The (possibly) interpolated property value.