org.ocpsoft.rewrite.bind
Class ParameterizedPattern

java.lang.Object
  org.ocpsoft.rewrite.bind.ParameterizedPattern

public class ParameterizedPattern
extends java.lang.Object

An Parameterized regular expression Pattern.

Author:

Lincoln Baxter, III

Constructor Summary

ParameterizedPattern(CaptureType type, java.lang.String pattern)
Create a new ParameterizedPattern instance with the default parameter regex of ".*".

ParameterizedPattern(CaptureType type, java.lang.String parameterPattern, java.lang.String pattern)
Create a new ParameterizedPattern instance.

ParameterizedPattern(java.lang.String pattern)
Create a new ParameterizedPattern instance with the default CaptureType.BRACE and parameter pattern of ".*".

ParameterizedPattern(java.lang.String parameterPattern, java.lang.String pattern)
Create a new ParameterizedPattern instance with the default CaptureType.BRACE.

Method Summary

java.lang.String	build(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> values) Use this expression to build a String from the given pattern and values.
java.lang.String	build(java.lang.Object... values) Use this expression to build a String from the given pattern and values.
java.lang.String	build(Rewrite event, EvaluationContext context) Use this expression to build a String from the given pattern.
java.lang.String	buildUnsafe(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> values) Use this expression to build a String from the given pattern and values.
java.lang.String	buildUnsafe(java.lang.Object... values) Use this expression to build a String from the given pattern and values.
RegexParameter	getParameter(java.lang.String name) Get the Parameter with the given name.
java.util.List<java.lang.String>	getParameterNames() Get a List of all defined Parameter names.
java.util.Map<java.lang.String,RegexParameter>	getParameters() Get all Parameter instances detected during expression parsing.
boolean	matches(Rewrite event, EvaluationContext context, java.lang.String value) Return true if this expression matches the given String.
java.util.Map<RegexParameter,java.lang.String[]>	parse(Rewrite event, EvaluationContext context, java.lang.String path) Parses the given string if it matches this expression.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterizedPattern

public ParameterizedPattern(java.lang.String pattern)

Create a new ParameterizedPattern instance with the default CaptureType.BRACE and parameter pattern of ".*".

ParameterizedPattern

public ParameterizedPattern(java.lang.String parameterPattern,
                            java.lang.String pattern)

Create a new ParameterizedPattern instance with the default CaptureType.BRACE.

ParameterizedPattern

public ParameterizedPattern(CaptureType type,
                            java.lang.String pattern)

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

ParameterizedPattern

public ParameterizedPattern(CaptureType type,
                            java.lang.String parameterPattern,
                            java.lang.String pattern)

Create a new ParameterizedPattern instance.

Method Detail

getParameters

public java.util.Map<java.lang.String,RegexParameter> getParameters()

Get all Parameter instances detected during expression parsing.

build

public java.lang.String build(Rewrite event,
                              EvaluationContext context)

Use this expression to build a String from the given pattern. Extract needed values from registered Binding instances.

build

public java.lang.String build(java.lang.Object... values)

Use this expression to build a String from the given pattern and values.

buildUnsafe

public java.lang.String buildUnsafe(java.lang.Object... values)

Use this expression to build a String from the given pattern and values. Enforces that the number of values passed must equal the number of expression parameters.

build

public java.lang.String build(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> values)

Use this expression to build a String from the given pattern and values. Enforces that the number of keys passed must equal the number of expression parameters.

buildUnsafe

public java.lang.String buildUnsafe(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> values)

Use this expression to build a String from the given pattern and values.

matches

public boolean matches(Rewrite event,
                       EvaluationContext context,
                       java.lang.String value)

Return true if this expression matches the given String.

parse

public java.util.Map<RegexParameter,java.lang.String[]> parse(Rewrite event,
                                                              EvaluationContext context,
                                                              java.lang.String path)

Parses the given string if it matches this expression. Returns a Parameter-value map of parsed values.

getParameter

public RegexParameter getParameter(java.lang.String name)

Get the Parameter with the given name. Return null if no such Parameter exists.

getParameterNames

public java.util.List<java.lang.String> getParameterNames()

Get a List of all defined Parameter names.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object