org.ocpsoft.rewrite.param

Interface ParameterizedPatternResult

public interface ParameterizedPatternResult

Stores the result of ParameterizedPatternParser#matches(Rewrite, EvaluationContext, String). Provides methods for controlling parameter value submission.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
Map<Parameter<?>,String>	getParameters(EvaluationContext context) Get the Map of Parameter instances that were referenced in the ParameterizedPattern.
boolean	isValid(Rewrite event, EvaluationContext context) Validate all Parameter values defined within the original ParameterizedPattern.
boolean	matches() Returns true if the ParameterizedPattern matched the input value, false if not.
boolean	submit(Rewrite event, EvaluationContext context) Submit all Parameter values to the ParameterValueStore, only if the values are match a prior value or have not yet had a value set.

Method Detail

matches

boolean matches()

Returns true if the ParameterizedPattern matched the input value, false if not.

isValid

boolean isValid(Rewrite event,
                EvaluationContext context)

Validate all Parameter values defined within the original ParameterizedPattern. Return true if all values matched configured Constraint instances, and matched an already submitted parameter value; otherwise, return false.

submit

boolean submit(Rewrite event,
               EvaluationContext context)

Submit all Parameter values to the ParameterValueStore, only if the values are match a prior value or have not yet had a value set. Returns true if submission was successful, false if not.

getParameters

Map<Parameter<?>,String> getParameters(EvaluationContext context)

Get the Map of Parameter instances that were referenced in the ParameterizedPattern.