org.ocpsoft.rewrite.param

Interface ParameterizedPatternBuilder

All Superinterfaces:

Parameterized, ParameterizedPattern

All Known Implementing Classes:

RegexParameterizedPatternBuilder

public interface ParameterizedPatternBuilder
extends ParameterizedPattern

A Parameterized regular expression Pattern.

Author:

Lincoln Baxter, III

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> parameters) 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.
boolean	isParameterComplete(Rewrite event, EvaluationContext context) Returns true if all parameters required by this builder are available; otherwise, returns false.

Methods inherited from interface org.ocpsoft.rewrite.param.ParameterizedPattern

getPattern

Methods inherited from interface org.ocpsoft.rewrite.param.Parameterized

getRequiredParameterNames, setParameterStore

Method Detail

getParser

ParameterizedPatternParser getParser()

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

build

String build(Rewrite event,
           EvaluationContext context)
             throws ParameterizationException

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

Throws:

{@link - ParameterizationException} when a required parameter is missing.

ParameterizationException

build

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

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.

Throws:

{@link - ParameterizationException} when a required parameter is missing.

ParameterizationException

build

String build(Map<String,Object> parameters)
             throws ParameterizationException

Use this expression to build a String from given values.

Throws:

{@link - ParameterizationException} when a required parameter is missing.

ParameterizationException

build

String build(List<Object> values)
             throws ParameterizationException

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.

Throws:

{@link - ParameterizationException} when a required parameter is missing.

ParameterizationException

isParameterComplete

boolean isParameterComplete(Rewrite event,
                          EvaluationContext context)

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