org.ocpsoft.rewrite.param

Class DefaultParameterValueStore

java.lang.Object

org.ocpsoft.rewrite.param.DefaultParameterValueStore

All Implemented Interfaces:

Iterable<Map.Entry<Parameter<?>,String>>, ParameterValueStore

public class DefaultParameterValueStore
extends Object
implements ParameterValueStore, Iterable<Map.Entry<Parameter<?>,String>>

Default implementation of ParameterValueStore

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Constructor and Description
DefaultParameterValueStore() Create a new, empty DefaultParameterValueStore instance.
DefaultParameterValueStore(DefaultParameterValueStore instance) Create a new DefaultParameterValueStore instance, copying all Parameter and value pairs from the given instance.

Method Summary

Modifier and Type	Method and Description
static ParameterValueStore	getInstance(EvaluationContext context) Retrieve the current ParameterValueStore from the given EvaluationContext instance.
boolean	isValid(Rewrite event, EvaluationContext context, Parameter<?> param, String value) Validate the given Parameter and value.
Iterator<Map.Entry<Parameter<?>,String>>	iterator()
String	retrieve(Parameter<?> parameter) Retrieve the currenet value for the given Parameter.
boolean	submit(Rewrite event, EvaluationContext context, Parameter<?> param, String value) Submit the given Parameter and value.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultParameterValueStore

public DefaultParameterValueStore()

Create a new, empty DefaultParameterValueStore instance.

DefaultParameterValueStore

public DefaultParameterValueStore(DefaultParameterValueStore instance)

Create a new DefaultParameterValueStore instance, copying all Parameter and value pairs from the given instance.

Method Detail

retrieve

public String retrieve(Parameter<?> parameter)

Description copied from interface: ParameterValueStore

Retrieve the currenet value for the given Parameter. (May be null if no value has been set, or if the value is null.)

Specified by:

retrieve in interface ParameterValueStore

submit

public boolean submit(Rewrite event,
                      EvaluationContext context,
                      Parameter<?> param,
                      String value)

Description copied from interface: ParameterValueStore

Submit the given Parameter and value. Return false if the value does not match configured Constraint instances, or does not match an already submitted value; otherwise, return true..

Specified by:

submit in interface ParameterValueStore

isValid

public boolean isValid(Rewrite event,
                       EvaluationContext context,
                       Parameter<?> param,
                       String value)

Description copied from interface: ParameterValueStore

Validate the given Parameter and value. Return false if the value does not match configured Constraint instances, or does not match an already submitted value; otherwise, return true.

Specified by:

isValid in interface ParameterValueStore

iterator

public Iterator<Map.Entry<Parameter<?>,String>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<Parameter<?>,String>>

toString

public String toString()

Overrides:

toString in class Object

getInstance

public static ParameterValueStore getInstance(EvaluationContext context)
                                       throws IllegalStateException

Retrieve the current ParameterValueStore from the given EvaluationContext instance.

Throws:

IllegalStateException - If the ParameterValueStore could not be located.