Package org.mycore.common

Class MCRPropertiesResolver

java.lang.Object

org.mycore.common.MCRTextResolver

org.mycore.common.MCRPropertiesResolver

public class MCRPropertiesResolver
extends MCRTextResolver

The MCRPropertiesResolver supports substitution of any %reference% in a String or Property instance.

// possible use case
Properties p = MCRConfiguration.instance().getProperties();
MCRPropertiesResolver r = new MCRPropertiesResolver(p);
Properties resolvedProperties = r.resolveAll(p);

Author:

Matthias Eichner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MCRPropertiesResolver.Property

Nested classes/interfaces inherited from class org.mycore.common.MCRTextResolver

MCRTextResolver.CircularDependencyExecption, MCRTextResolver.CircularDependencyTracker, MCRTextResolver.Condition, MCRTextResolver.EscapeCharacter, MCRTextResolver.ResolveDepth, MCRTextResolver.Term, MCRTextResolver.TermContainer, MCRTextResolver.Text, MCRTextResolver.Variable

Field Summary

Fields inherited from class org.mycore.common.MCRTextResolver

resolveDepth, retainText, termContainer, tracker, variablesMap

Constructor Summary

Constructors

Constructor	Description
MCRPropertiesResolver()
MCRPropertiesResolver(Map<String,String> propertiesMap)
MCRPropertiesResolver(Properties properties)

Method Summary

Modifier and Type	Method	Description
String	addVariable(String name, String value)	Adds a new variable to the resolver.
protected void	registerDefaultTerms()	Creates the term list for the text resolver and adds the default terms.
Map<String,String>	resolveAll(Map<String,String> toResolve)	Substitute all %references% of the given Map and return a new Map object.
Properties	resolveAll(Properties toResolve)	Substitute all %references% of the given Properties and return a new Properties object.

Methods inherited from class org.mycore.common.MCRTextResolver

containsVariable, getResolveDepth, getTermContainer, getTracker, getValue, getVariables, isRetainText, mixin, mixin, registerTerm, removeVariable, resolve, setResolveDepth, setRetainText, unregisterTerm

Methods inherited from class java.lang.Object

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

Constructor Details

MCRPropertiesResolver

public MCRPropertiesResolver()

MCRPropertiesResolver

public MCRPropertiesResolver(Map<String,String> propertiesMap)

MCRPropertiesResolver

public MCRPropertiesResolver(Properties properties)

Method Details

addVariable

public String addVariable(String name,
 String value)

Description copied from class: MCRTextResolver

Adds a new variable to the resolver. This overwrites a existing variable with the same name.

Overrides:

addVariable in class MCRTextResolver

Parameters:

name - name of the variable

value - value of the variable

Returns:

the previous value of the specified name, or null if it did not have one

registerDefaultTerms

protected void registerDefaultTerms()
                             throws NoSuchMethodException,
InvocationTargetException,
IllegalAccessException,
InstantiationException

Description copied from class: MCRTextResolver

Creates the term list for the text resolver and adds the default terms.

Overrides:

registerDefaultTerms in class MCRTextResolver

Throws:

NoSuchMethodException

InvocationTargetException

IllegalAccessException

InstantiationException

resolveAll

public Properties resolveAll(Properties toResolve)

Substitute all %references% of the given Properties and return a new Properties object.

Parameters:

toResolve - properties to resolve

Returns:

resolved properties

resolveAll

public Map<String,String> resolveAll(Map<String,String> toResolve)

Substitute all %references% of the given Map and return a new Map object.

Parameters:

toResolve - properties to resolve

Returns:

resolved properties