net.openhft.chronicle.bytes.util

Enum PropertyReplacer

java.lang.Object

java.lang.Enum<PropertyReplacer>

net.openhft.chronicle.bytes.util.PropertyReplacer

All Implemented Interfaces:

Serializable, Comparable<PropertyReplacer>

public enum PropertyReplacer
extends Enum<PropertyReplacer>

Utility for substituting property placeholders in strings. Placeholders are expected in the form ${propertyName} where optional ASCII white space inside the braces is ignored. The class is stateless and therefore thread safe.

Method Summary

Modifier and Type	Method and Description
static String	replaceTokensWithProperties(String expression) Replaces tokens of the format ${property} in the given expression with their corresponding system property values.
static String	replaceTokensWithProperties(String expression, Properties properties) Replaces tokens of the format ${property} in the given expression with their corresponding values from the provided Properties object.
static PropertyReplacer	valueOf(String name) Returns the enum constant of this type with the specified name.
static PropertyReplacer[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static PropertyReplacer[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PropertyReplacer c : PropertyReplacer.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PropertyReplacer valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

replaceTokensWithProperties

public static String replaceTokensWithProperties(String expression)
                                          throws IllegalArgumentException

Replaces tokens of the format ${property} in the given expression with their corresponding system property values. If a placeholder has no matching property an IllegalArgumentException is thrown.

Parameters:

expression - the input string containing tokens to be replaced

Returns:

a new string with tokens replaced by system property values

Throws:

IllegalArgumentException - if a token has no matching system property

NullPointerException - if expression is null

replaceTokensWithProperties

public static String replaceTokensWithProperties(String expression,
                                                 Properties properties)
                                          throws IllegalArgumentException

Replaces tokens of the format ${property} in the given expression with their corresponding values from the provided Properties object. Unresolved tokens result in an IllegalArgumentException.

Parameters:

expression - the input string containing tokens to be replaced

properties - the property source used for substitutions

Returns:

a new string with tokens replaced by values from properties

Throws:

IllegalArgumentException - if a token has no corresponding property

NullPointerException - if expression or properties is null