Package org.forgerock.config.resolvers

Class SubstitutionVisitor

java.lang.Object

org.forgerock.config.resolvers.SubstitutionVisitor

All Implemented Interfaces:

TemplateVisitor<String,SubstitutionContext>

public final class SubstitutionVisitor
extends Object
implements TemplateVisitor<String,SubstitutionContext>

This visitor evaluates Templates with the help of a PropertyResolver.

It supports recursive evaluation if given a TemplateParser.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubstitutionVisitor.Builder	Builder of SubstitutionVisitor.

Method Summary

Modifier and Type	Method	Description
static SubstitutionVisitor.Builder	substitution(PropertyResolver resolver)	Create a builder for SubstitutionVisitor.
String	visitEmpty(SubstitutionContext context)	Visit an empty template with the given context object.
String	visitProperty(SubstitutionContext context, Template property, Template defaultValue)	Visit a property template with the given context object.
String	visitSequence(SubstitutionContext context, List<Template> sequence)	Visit a sequence of templates with the given context object.
String	visitText(SubstitutionContext context, String text)	Visit a textual template with the given context object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.config.resolvers.template.TemplateVisitor

visitAny

Method Detail

substitution

public static SubstitutionVisitor.Builder substitution(PropertyResolver resolver)

Create a builder for SubstitutionVisitor.

Parameters:

resolver - property resolver used to evaluate properties

Returns:

a new builder

visitText

public String visitText(SubstitutionContext context,
                        String text)

Description copied from interface: TemplateVisitor

Visit a textual template with the given context object.

Specified by:

visitText in interface TemplateVisitor<String,SubstitutionContext>

Parameters:

context - the contextual object (can be null)

text - the text contained in the visited textual template

Returns:

the result of the operation on the template

visitEmpty

public String visitEmpty(SubstitutionContext context)

Description copied from interface: TemplateVisitor

Visit an empty template with the given context object.

Specified by:

visitEmpty in interface TemplateVisitor<String,SubstitutionContext>

Parameters:

context - the contextual object (can be null)

Returns:

the result of the operation on the template

visitProperty

public String visitProperty(SubstitutionContext context,
                            Template property,
                            Template defaultValue)

Description copied from interface: TemplateVisitor

Visit a property template with the given context object.

Specified by:

visitProperty in interface TemplateVisitor<String,SubstitutionContext>

Parameters:

context - the contextual object (can be null)

property - the template that defines the property's name

defaultValue - the template that defines the property's default value

Returns:

the result of the operation on the template

visitSequence

public String visitSequence(SubstitutionContext context,
                            List<Template> sequence)

Description copied from interface: TemplateVisitor

Visit a sequence of templates with the given context object.

Specified by:

visitSequence in interface TemplateVisitor<String,SubstitutionContext>

Parameters:

context - the contextual object (can be null)

sequence - the (never null) list of templates within this sequence

Returns:

the result of the operation on the template