org.ocpsoft.rewrite.param

Class RegexParameterizedPatternBuilder

java.lang.Object

org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder

All Implemented Interfaces:

Parameterized, ParameterizedPattern, ParameterizedPatternBuilder

public class RegexParameterizedPatternBuilder
extends Object
implements ParameterizedPatternBuilder

An Parameterized regular expression Pattern.

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Constructor and Description
RegexParameterizedPatternBuilder(ParseTools.CaptureType type, String pattern) Create a new RegexParameterizedPatternBuilder instance with the default parameter regex of ".*".
RegexParameterizedPatternBuilder(ParseTools.CaptureType type, String defaultParameterPattern, String pattern) Create a new RegexParameterizedPatternBuilder instance.
RegexParameterizedPatternBuilder(String pattern) Create a new RegexParameterizedPatternBuilder instance with the default org.ocpsoft.rewrite.bind.parse.CaptureType#BRACE and parameter compiledPattern of ".*".
RegexParameterizedPatternBuilder(String parameterPattern, String pattern) Create a new RegexParameterizedPatternBuilder instance with the default ParseTools.CaptureType.BRACE.

Method Summary

Methods

Modifier and Type	Method and Description
String	build(List<Object> values) Use this expression's pattern to build a String from the given values.
String	build(Map<String,Object> values) Use this expression to build a String from given values.
String	build(Rewrite event, EvaluationContext context) Use this expression to build a String from this expression's pattern.
String	build(Rewrite event, EvaluationContext context, Transposition<String> transposition) Use this expression to build a String from this expression's pattern.
ParameterizedPatternParser	getParser() Return the ParameterizedPatternParser corresponding to the pattern with which this ParameterizedPatternBuilder was constructed.
String	getPattern() Get the pattern for which this ParameterizedPattern represents.
Set<String>	getRequiredParameterNames() Get all required Parameter names for this Parameterized instance.
boolean	isParameterComplete(Rewrite event, EvaluationContext context) Returns true if all parameters required by this builder are available; otherwise, returns false.
void	setParameterStore(ParameterStore store) Initialize this Parameterized instance with the global ParameterStore.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexParameterizedPatternBuilder

public RegexParameterizedPatternBuilder(String pattern)

Create a new RegexParameterizedPatternBuilder instance with the default org.ocpsoft.rewrite.bind.parse.CaptureType#BRACE and parameter compiledPattern of ".*".

RegexParameterizedPatternBuilder

public RegexParameterizedPatternBuilder(String parameterPattern,
                                String pattern)

Create a new RegexParameterizedPatternBuilder instance with the default ParseTools.CaptureType.BRACE.

RegexParameterizedPatternBuilder

public RegexParameterizedPatternBuilder(ParseTools.CaptureType type,
                                String pattern)

Create a new RegexParameterizedPatternBuilder instance with the default parameter regex of ".*".

RegexParameterizedPatternBuilder

public RegexParameterizedPatternBuilder(ParseTools.CaptureType type,
                                String defaultParameterPattern,
                                String pattern)

Create a new RegexParameterizedPatternBuilder instance.

Method Detail

build

public String build(Rewrite event,
           EvaluationContext context)
             throws ParameterizationException

Description copied from interface: ParameterizedPatternBuilder

Use this expression to build a String from this expression's pattern. Extract needed values from the EvaluationContext.

Specified by:

build in interface ParameterizedPatternBuilder

Throws:

ParameterizationException

build

public String build(Rewrite event,
           EvaluationContext context,
           Transposition<String> transposition)
             throws ParameterizationException

Description copied from interface: ParameterizedPatternBuilder

Use this expression to build a String from this expression's pattern. Extract needed values from the EvaluationContext. The given Transposition instances will be performed on each parameter in the order that they were provided.

Specified by:

build in interface ParameterizedPatternBuilder

Throws:

ParameterizationException

build

public String build(List<Object> values)
             throws ParameterizationException

Description copied from interface: ParameterizedPatternBuilder

Use this expression's pattern to build a String from the given values. Enforces that the number of values passed must equal the number of expression parameters. Does not apply any configured Transposition instances.

Specified by:

build in interface ParameterizedPatternBuilder

Throws:

ParameterizationException

build

public String build(Map<String,Object> values)
             throws ParameterizationException

Description copied from interface: ParameterizedPatternBuilder

Use this expression to build a String from given values.

Specified by:

build in interface ParameterizedPatternBuilder

Throws:

ParameterizationException

toString

public String toString()

Overrides:

toString in class Object

getPattern

public String getPattern()

Description copied from interface: ParameterizedPattern

Get the pattern for which this ParameterizedPattern represents.

Specified by:

getPattern in interface ParameterizedPattern

getParser

public ParameterizedPatternParser getParser()

Description copied from interface: ParameterizedPatternBuilder

Return the ParameterizedPatternParser corresponding to the pattern with which this ParameterizedPatternBuilder was constructed.

Specified by:

getParser in interface ParameterizedPatternBuilder

getRequiredParameterNames

public Set<String> getRequiredParameterNames()

Description copied from interface: Parameterized

Get all required Parameter names for this Parameterized instance.

Specified by:

getRequiredParameterNames in interface Parameterized

setParameterStore

public void setParameterStore(ParameterStore store)

Description copied from interface: Parameterized

Initialize this Parameterized instance with the global ParameterStore.

Specified by:

setParameterStore in interface Parameterized

isParameterComplete

public boolean isParameterComplete(Rewrite event,
                          EvaluationContext context)

Description copied from interface: ParameterizedPatternBuilder

Returns true if all parameters required by this builder are available; otherwise, returns false.

Specified by:

isParameterComplete in interface ParameterizedPatternBuilder