net.jmatrix.jproperties.substitution

Class SubstitutionProcessor

java.lang.Object

net.jmatrix.jproperties.substitution.SubstitutionProcessor

public final class SubstitutionProcessor
extends Object

Static methods used to substitute tokens for values. Note: This class has some very tricky logic supporting 2 types of substitutions (partial and complete), nested tokens (${key.${env}}), and default values. When changing this class you should: a) know what you are doing b) know the desired token substitution syntax and function. c) test extensively with many tokenized properties files. you have been warned. Bemo, 21 July 2009.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	debug
static org.apache.commons.logging.Log	log
static int	MAX_RECURSIVE_SUBSTITUTIONS

Constructor Summary

Constructors

Constructor and Description
SubstitutionProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	containsTokens(String s)
static String	processSubstitution(String s, JProperties p) Public facing method.
static Object	processSubstitution(String s, JProperties p, Class returnType)

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.commons.logging.Log log

MAX_RECURSIVE_SUBSTITUTIONS

public static int MAX_RECURSIVE_SUBSTITUTIONS

debug

public static boolean debug

Constructor Detail

SubstitutionProcessor

public SubstitutionProcessor()

Method Detail

processSubstitution

public static final String processSubstitution(String s,
                         JProperties p)

Public facing method. There are 2 types of substitutions: partial and complete. Complete substitutions are only possible when the value is simply the token. Partial substitutions are string only. Complete substitutions can replace a token with an object - like EProperties or List. Partial Substitution: key="This is a string with a ${token} value" Complete Substitution: key2=${token} The result of a partial substitution is ALWAYS a String. The result of a complete substitution can be any of [ String, EProperties, List ].

containsTokens

public static final boolean containsTokens(String s)

processSubstitution

public static final Object processSubstitution(String s,
                         JProperties p,
                         Class returnType)