org.ocpsoft.rewrite.config

Class ConfigurationRuleBuilder

java.lang.Object

org.ocpsoft.rewrite.config.ConfigurationBuilder

org.ocpsoft.rewrite.config.ConfigurationRuleBuilder

All Implemented Interfaces:

Condition, Configuration, ConfigurationBuilderRoot, ConfigurationRuleBuilderCustom, ConfigurationRuleBuilderOtherwise, ConfigurationRuleBuilderPerform, ConfigurationRuleBuilderWhen, ConfigurationRuleBuilderWithId, ConfigurationRuleBuilderWithMetadata, ConfigurationRuleBuilderWithPriority, ConfigurationRuleBuilderWithPriorityAndId, Operation, Rule, Parameterized, ParameterizedRule

public class ConfigurationRuleBuilder
extends ConfigurationBuilder
implements ParameterizedRule, ConfigurationRuleBuilderCustom, ConfigurationRuleBuilderWhen, ConfigurationRuleBuilderPerform, ConfigurationRuleBuilderOtherwise, ConfigurationRuleBuilderWithId, ConfigurationRuleBuilderWithPriority, ConfigurationRuleBuilderWithPriorityAndId

An intermediate stage Rule configuration.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
ConfigurationRuleBuilderCustom	addRule() Add a new fluent Rule.
ConfigurationRuleBuilder	addRule(Rule rule) Add a Rule.
boolean	evaluate(Rewrite event, EvaluationContext context) Evaluate this condition against the given Rewrite event.
String	getId() Get the ID for this Rule
ParameterStore	getParameterStore() Return the ParameterStore for this Rule
Set<String>	getRequiredParameterNames() Get all required Parameter names for this Parameterized instance.
RuleBuilder	getRuleBuilder() Provides access to the RuleBuilder for the current Rule.
List<RuleBuilder>	getRuleBuilders()
List<Rule>	getRules() Get the list of Rule instances defined by this Configuration
ConfigurationRuleBuilder	otherwise(Operation operation) Perform the given Operation when the conditions set in this Rule fail to be met.
ConfigurationRuleBuilderOtherwise	otherwise(Operation operation, Operation... operations) Perform the given Operation instances when the conditions set in this Rule fail to be met.
ConfigurationRuleBuilder	perform(Operation operation) Perform the given Operation when the conditions set in this Rule are met.
ConfigurationRuleBuilderPerform	perform(Operation operation, Operation... operations) Perform the given Operation instances when the conditions set in this Rule are met.
void	perform(Rewrite event, EvaluationContext context) Perform the Operation.
void	setParameterStore(ParameterStore store) Initialize this Parameterized instance with the global ParameterStore.
ConfigurationRuleBuilder	when(Condition condition) Set the Condition of this Rule instance.
ConfigurationRuleBuilderWhen	when(Condition condition, Condition... conditions) Set the Conditions of this Rule instance.
ConfigurationRuleParameterBuilder	where(String name) Configure the Parameter with the given name.
ConfigurationRuleBuilder	withId(String id) Set the ID for the current Rule.
ConfigurationRuleBuilderWithMetadata	withMetadata(Object key, Object value) Specify additional meta-data to be associated with this Rule.
ConfigurationRuleBuilder	withPriority(int priority) Set the priority of this Rule instance.

Methods inherited from class org.ocpsoft.rewrite.config.ConfigurationBuilder

begin, toString

Methods inherited from class java.lang.Object

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

Method Detail

addRule

public ConfigurationRuleBuilder addRule(Rule rule)

Description copied from class: ConfigurationBuilder

Add a Rule.

Specified by:

addRule in interface ConfigurationBuilderRoot

Overrides:

addRule in class ConfigurationBuilder

addRule

public ConfigurationRuleBuilderCustom addRule()

Description copied from class: ConfigurationBuilder

Add a new fluent Rule.

Specified by:

addRule in interface ConfigurationBuilderRoot

Overrides:

addRule in class ConfigurationBuilder

where

public ConfigurationRuleParameterBuilder where(String name)

Description copied from interface: ConfigurationRuleBuilderPerform

Configure the Parameter with the given name.

Specified by:

where in interface ConfigurationRuleBuilderOtherwise

Specified by:

where in interface ConfigurationRuleBuilderPerform

when

public ConfigurationRuleBuilder when(Condition condition)

Description copied from interface: ConfigurationRuleBuilderCustom

Set the Condition of this Rule instance.

Specified by:

when in interface ConfigurationRuleBuilderCustom

when

public ConfigurationRuleBuilderWhen when(Condition condition,
                                         Condition... conditions)

Description copied from interface: ConfigurationRuleBuilderCustom

Set the Conditions of this Rule instance. This creates an implicit And between all provided Condition instances.

Specified by:

when in interface ConfigurationRuleBuilderCustom

perform

public ConfigurationRuleBuilder perform(Operation operation)

Description copied from interface: ConfigurationRuleBuilderCustom

Perform the given Operation when the conditions set in this Rule are met.

Specified by:

perform in interface ConfigurationRuleBuilderCustom

Specified by:

perform in interface ConfigurationRuleBuilderWhen

perform

public ConfigurationRuleBuilderPerform perform(Operation operation,
                                               Operation... operations)

Description copied from interface: ConfigurationRuleBuilderCustom

Perform the given Operation instances when the conditions set in this Rule are met.

Specified by:

perform in interface ConfigurationRuleBuilderCustom

Specified by:

perform in interface ConfigurationRuleBuilderWhen

otherwise

public ConfigurationRuleBuilder otherwise(Operation operation)

Description copied from interface: ConfigurationRuleBuilderWhen

Perform the given Operation when the conditions set in this Rule fail to be met.

Specified by:

otherwise in interface ConfigurationRuleBuilderPerform

Specified by:

otherwise in interface ConfigurationRuleBuilderWhen

otherwise

public ConfigurationRuleBuilderOtherwise otherwise(Operation operation,
                                                   Operation... operations)

Description copied from interface: ConfigurationRuleBuilderWhen

Perform the given Operation instances when the conditions set in this Rule fail to be met.

Specified by:

otherwise in interface ConfigurationRuleBuilderPerform

Specified by:

otherwise in interface ConfigurationRuleBuilderWhen

withPriority

public ConfigurationRuleBuilder withPriority(int priority)

Description copied from interface: ConfigurationRuleBuilderPerform

Set the priority of this Rule instance. If #priority() differs from the priority of the ConfigurationProvider from which this rule was returned, then relocate this rule to its new priority position in the compiled rule set.

Specified by:

withPriority in interface ConfigurationRuleBuilderOtherwise

Specified by:

withPriority in interface ConfigurationRuleBuilderPerform

Specified by:

withPriority in interface ConfigurationRuleBuilderWithId

withId

public ConfigurationRuleBuilder withId(String id)

Description copied from interface: ConfigurationRuleBuilderPerform

Set the ID for the current Rule. This may be used in logging and for rule lookup purposes.

Specified by:

withId in interface ConfigurationRuleBuilderOtherwise

Specified by:

withId in interface ConfigurationRuleBuilderPerform

Specified by:

withId in interface ConfigurationRuleBuilderWithPriority

getRuleBuilder

public RuleBuilder getRuleBuilder()

Provides access to the RuleBuilder for the current Rule.

getRules

public List<Rule> getRules()

Description copied from interface: Configuration

Get the list of Rule instances defined by this Configuration

Specified by:

getRules in interface Configuration

Overrides:

getRules in class ConfigurationBuilder

getRuleBuilders

public List<RuleBuilder> getRuleBuilders()

Overrides:

getRuleBuilders in class ConfigurationBuilder

getParameterStore

public ParameterStore getParameterStore()

Description copied from interface: ParameterizedRule

Return the ParameterStore for this Rule

Specified by:

getParameterStore in interface ParameterizedRule

getId

public String getId()

Description copied from interface: Rule

Get the ID for this Rule

Specified by:

getId in interface Rule

evaluate

public boolean evaluate(Rewrite event,
                        EvaluationContext context)

Description copied from interface: Condition

Evaluate this condition against the given Rewrite event. If this condition does not apply to the given event, it must return false. If the condition applies and is satisfied, return true.

Specified by:

evaluate in interface Condition

perform

public void perform(Rewrite event,
                    EvaluationContext context)

Description copied from interface: Operation

Perform the Operation.

Specified by:

perform in interface Operation

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

withMetadata

public ConfigurationRuleBuilderWithMetadata withMetadata(Object key,
                                                         Object value)

Description copied from interface: ConfigurationRuleBuilderWithMetadata

Specify additional meta-data to be associated with this Rule. Meta-data does not directly affect a Rule's behavior, but can be used to provide hints to custom extensions.

Specified by:

withMetadata in interface ConfigurationRuleBuilderWithMetadata