Skip navigation links
rewrite-api 3.5.0.Final
A B C D E F G H I K L M N O P R S T V W 

A

AbstractRewrite - Class in org.ocpsoft.rewrite
 
AbstractRewrite() - Constructor for class org.ocpsoft.rewrite.AbstractRewrite
 
accept(Visitor<Condition>) - Method in class org.ocpsoft.rewrite.config.ConditionVisit
Submit the supplied visitor and apply it to all Condition instances in the tree
accept(Visitor<Operation>) - Method in class org.ocpsoft.rewrite.config.OperationVisit
Submit the supplied visitor and apply it to all Operation instances in the tree
accept(Visitor<Condition>) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
This method will call the supplied visitor for all conditions attached to the rule builder.
accept(Visitor<Rule>) - Method in class org.ocpsoft.rewrite.config.RuleVisit
Submit the supplied Visitor and apply it to all Rule instances in the tree
addArrayValue(Map<T, String[]>, T, String) - Static method in class org.ocpsoft.rewrite.util.Maps
 
addDelegate(Map<KEYTYPE, VALUETYPE>) - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
addListValue(Map<K, List<T>>, K, T) - Static method in class org.ocpsoft.rewrite.config.ConfigurationLoader
 
addListValue(Map<K, List<T>>, K, T) - Static method in class org.ocpsoft.rewrite.util.Maps
 
addPostOperation(Operation) - Method in interface org.ocpsoft.rewrite.context.EvaluationContext
Add a new Operation to be performed if all conditions of this rule are met.
addPreOperation(Operation) - Method in interface org.ocpsoft.rewrite.context.EvaluationContext
Add a new Operation to be performed if all conditions of this rule are met.
addRule() - Method in class org.ocpsoft.rewrite.config.ConfigurationBuilder
Add a new fluent Rule.
addRule(Rule) - Method in class org.ocpsoft.rewrite.config.ConfigurationBuilder
Add a Rule.
addRule() - Method in interface org.ocpsoft.rewrite.config.ConfigurationBuilderRoot
Define a new fluent Rule.
addRule(Rule) - Method in interface org.ocpsoft.rewrite.config.ConfigurationBuilderRoot
Add a pre-defined Rule.
addRule(Rule) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
addRule() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
addRule() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
addRule(Rule) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
all(Condition...) - Static method in class org.ocpsoft.rewrite.config.And
Creates a new And condition.
all(Operation...) - Static method in class org.ocpsoft.rewrite.config.Perform
Creates a new Perform operation.
And - Class in org.ocpsoft.rewrite.config
Evaluates all provided Condition instances.
and(Condition) - Method in interface org.ocpsoft.rewrite.config.ConditionBuilder
Append a new Condition to this builder, which must evaluate to true in order for this composite Condition to evaluate to true.
and(Condition) - Method in class org.ocpsoft.rewrite.config.DefaultConditionBuilder
 
and(Operation) - Method in class org.ocpsoft.rewrite.config.DefaultOperationBuilder
 
and(Operation) - Method in interface org.ocpsoft.rewrite.config.OperationBuilder
Join this instance with another Operation.
andNot(Condition) - Method in interface org.ocpsoft.rewrite.config.ConditionBuilder
Append a new Condition to this builder, which must not evaluate to true in order for this composite Condition to evaluate to true.
andNot(Condition) - Method in class org.ocpsoft.rewrite.config.DefaultConditionBuilder
 
any(Condition) - Static method in class org.ocpsoft.rewrite.config.Not
Evaluates all provided Condition instances.
any(Condition...) - Static method in class org.ocpsoft.rewrite.config.Or
Creates a new Or condition.

B

balancedCapture(char[], int, int, ParseTools.CaptureType) - Static method in class org.ocpsoft.rewrite.util.ParseTools
Return the index of the terminating character in the group, excluding markers.
begin() - Static method in class org.ocpsoft.rewrite.config.ConfigurationBuilder
Begin defining a new fluent Configuration.
Binding - Interface in org.ocpsoft.rewrite.bind
Interface declaring the common tasks that must be performed when evaluating any Binding
binding(Retrieval) - Static method in class org.ocpsoft.rewrite.config.Invoke
Invoke the given Retrieval and process InvocationResultHandler instances on the result value (if any.)
binding(Submission, Retrieval) - Static method in class org.ocpsoft.rewrite.config.Invoke
Invoke Submission.submit(Rewrite, EvaluationContext, Object), use the result of the given Retrieval.retrieve(Rewrite, EvaluationContext) as the value for this submission.
bindsTo(Binding) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
bindsTo(Binding) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleParameterMatches
Add a Binding to this Parameter.
bindsTo(Binding) - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
bindsTo(Binding) - Method in interface org.ocpsoft.rewrite.param.ParameterConfiguration
build(Rewrite, EvaluationContext) - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternBuilder
Use this expression to build a String from this expression's pattern.
build(Rewrite, EvaluationContext, Transposition<String>) - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternBuilder
Use this expression to build a String from this expression's pattern.
build(Map<String, Object>) - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternBuilder
Use this expression to build a String from given values.
build(List<Object>) - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternBuilder
Use this expression's pattern to build a String from the given values.
build(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
 
build(Rewrite, EvaluationContext, Transposition<String>) - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
 
build(List<Object>) - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
 
build(Map<String, Object>) - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
 
bundle(String, String) - Static method in class org.ocpsoft.rewrite.transposition.LocaleTransposition
Create a Binding to a ResourceBundle, where the initial bound Parameter value is used as the bundle lookup key.

C

call(Parameterized) - Method in interface org.ocpsoft.rewrite.config.ParameterizedCallback
 
CapturingGroup(char[], int, int) - Constructor for class org.ocpsoft.rewrite.util.ParseTools.CapturingGroup
 
clear() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
clear() - Method in interface org.ocpsoft.rewrite.context.Context
Clear the contents of this context and reset to a "like-new" state.
clear() - Method in class org.ocpsoft.rewrite.context.ContextBase
 
clear() - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
clone() - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
CompositeCondition - Interface in org.ocpsoft.rewrite.config
A Condition that aggregates one or more conditions.
CompositeMap<KEYTYPE,VALUETYPE> - Class in org.ocpsoft.rewrite.util
Map implementation supporting delegation to other Map instances configured with CompositeMap.addDelegate(Map).
CompositeMap() - Constructor for class org.ocpsoft.rewrite.util.CompositeMap
 
CompositeOperation - Interface in org.ocpsoft.rewrite.config
An Operation that aggregates one or more operations.
CompositeRule - Interface in org.ocpsoft.rewrite.config
Defines a composite Rule, which can return other Rule instances contained within.
Condition - Interface in org.ocpsoft.rewrite.config
A condition that must be met in order for evaluation to return true.
ConditionBuilder - Interface in org.ocpsoft.rewrite.config
A Condition capable of logical operations with other Condition objects.
Conditions - Class in org.ocpsoft.rewrite.config
Utility for creating and wrapping Condition instances.
Conditions() - Constructor for class org.ocpsoft.rewrite.config.Conditions
 
conditionToString() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
ConditionVisit - Class in org.ocpsoft.rewrite.config
This class allows Visitors to walk through a Condition tree which may contain CompositeCondition elements.
ConditionVisit(Condition) - Constructor for class org.ocpsoft.rewrite.config.ConditionVisit
Initialize class with the supplied root Condition
ConfigurableParameter<IMPLTYPE extends ConfigurableParameter<IMPLTYPE>> - Interface in org.ocpsoft.rewrite.param
Provides mutable metadata for handling parameter behavior in Parameterized Condition, Operation, and Rule instances.
Configuration - Interface in org.ocpsoft.rewrite.config
Configuration for the Rewrite framework.
ConfigurationBuilder - Class in org.ocpsoft.rewrite.config
A fluent builder for defining Configuration objects.
ConfigurationBuilderRoot - Interface in org.ocpsoft.rewrite.config
 
ConfigurationCacheProvider<T> - Interface in org.ocpsoft.rewrite.spi
Provides Configuration caching strategies for the Rewrite runtime environment.
ConfigurationLoader - Class in org.ocpsoft.rewrite.config
Responsible for loading all ConfigurationProvider instances, and building a single unified Configuration based on Weighted.priority()
ConfigurationLoader(Object) - Constructor for class org.ocpsoft.rewrite.config.ConfigurationLoader
 
ConfigurationProvider<T> - Interface in org.ocpsoft.rewrite.config
Provides Configuration to the Rewrite runtime environment.
ConfigurationRuleBuilder - Class in org.ocpsoft.rewrite.config
An intermediate stage Rule configuration.
ConfigurationRuleBuilderCustom - Interface in org.ocpsoft.rewrite.config
An intermediate stage Rule configuration.
ConfigurationRuleBuilderInterceptor - Interface in org.ocpsoft.rewrite.spi
Intercepts values passed to the methods of ConfigurationBuilder when defining rules.
ConfigurationRuleBuilderOtherwise - Interface in org.ocpsoft.rewrite.config
An intermediate stage Rule configuration.
ConfigurationRuleBuilderPerform - Interface in org.ocpsoft.rewrite.config
An intermediate stage Rule configuration.
ConfigurationRuleBuilderWhen - Interface in org.ocpsoft.rewrite.config
An intermediate stage Rule configuration.
ConfigurationRuleBuilderWithId - Interface in org.ocpsoft.rewrite.config
An intermediate stage Rule configuration.
ConfigurationRuleBuilderWithMetadata - Interface in org.ocpsoft.rewrite.config
 
ConfigurationRuleBuilderWithPriority - Interface in org.ocpsoft.rewrite.config
An intermediate stage Rule configuration.
ConfigurationRuleBuilderWithPriorityAndId - Interface in org.ocpsoft.rewrite.config
An intermediate stage Rule configuration.
ConfigurationRuleParameter - Interface in org.ocpsoft.rewrite.config
ConfigurationRuleParameterBuilder - Class in org.ocpsoft.rewrite.config
ConfigurationRuleParameterBuilder(ConfigurationRuleBuilder, ConfigurableParameter<?>) - Constructor for class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
ConfigurationRuleParameterMatches - Interface in org.ocpsoft.rewrite.config
A ConfigurationRuleParameter with a matches clause.
ConfigurationRuleParameterWhere - Interface in org.ocpsoft.rewrite.config
A ConfigurationRuleParameter with a where clause.
configuredBy(ParameterConfigurator) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
configuredBy(ParameterConfigurator) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleParameterMatches
Add a ParameterConfigurator with which this Parameter will be configured.
configuredBy(ParameterConfigurator) - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
configuredBy(ParameterConfigurator) - Method in interface org.ocpsoft.rewrite.param.ParameterConfiguration
Add a ParameterConfigurator with which this ParameterConfiguration will be configured.
constrainedBy(Constraint<String>) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
constrainedBy(Constraint<String>) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleParameterMatches
Add a Constraint to which this object IMPLTYPE must match.
constrainedBy(Constraint<String>) - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
constrainedBy(Constraint<String>) - Method in interface org.ocpsoft.rewrite.param.ParameterConfiguration
Add a constraint to which this ParameterConfiguration must match.
Constraint<T> - Interface in org.ocpsoft.rewrite.param
Used to verify or restrict values before they are converted via the Converter API.
contains(String) - Method in class org.ocpsoft.rewrite.param.DefaultParameterStore
 
contains(String) - Method in interface org.ocpsoft.rewrite.param.ParameterStore
Return true if this ParameterStore contains a Parameter with the given name, otherwise return false.
containsKey(Object) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
containsKey(Object) - Method in interface org.ocpsoft.rewrite.context.Context
Return true if this context contains an entry with the given key.
containsKey(Object) - Method in class org.ocpsoft.rewrite.context.ContextBase
 
containsKey(Object) - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
containsValue(Object) - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
Context - Interface in org.ocpsoft.rewrite.context
An object capable of storing and retrieving values.
ContextBase - Class in org.ocpsoft.rewrite.context
Base Context abstract class.
ContextBase() - Constructor for class org.ocpsoft.rewrite.context.ContextBase
 
contextMap - Variable in class org.ocpsoft.rewrite.config.RuleBuilder
 
convert(Rewrite, EvaluationContext, Object) - Method in interface org.ocpsoft.rewrite.param.Converter
Convert the given Object into the expected type.
convert(Rewrite, EvaluationContext, Converter<?>, Object) - Static method in class org.ocpsoft.rewrite.util.ValueHolderUtil
 
convertedBy(Converter<?>) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
convertedBy(Converter<?>) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleParameterMatches
Set the Converter with which this Parameter value will be converted.
convertedBy(Converter<?>) - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
convertedBy(Converter<?>) - Method in interface org.ocpsoft.rewrite.param.ParameterConfiguration
Set the Converter with which this ParameterConfiguration value will be converted.
Converter<T> - Interface in org.ocpsoft.rewrite.param
Used to convert Parameter values before they are verified by the Validator API.
ConverterProvider - Interface in org.ocpsoft.rewrite.spi
SPI for providing integration with other conversion frameworks.
create() - Static method in class org.ocpsoft.rewrite.config.Conditions
Return a new DefaultConditionBuilder that evaluates to True when #evaluate(Rewrite, EvaluationContext) is invoked.
create(Object) - Static method in class org.ocpsoft.rewrite.config.ConfigurationLoader
Get a new ConfigurationLoader instance.
create() - Static method in class org.ocpsoft.rewrite.config.Operations
Return a new DefaultOperationBuilder that takes no action when #perform(Rewrite, EvaluationContext) is invoked.
createKey(Rewrite, EvaluationContext) - Method in interface org.ocpsoft.rewrite.spi.RuleCacheProvider
Create a unique key for the given Rewrite event and EvaluationContext states.

D

DefaultConditionBuilder - Class in org.ocpsoft.rewrite.config
Used as a base class to create fluent relationships between Condition objects; this class adds logical operators to any class extending it.
DefaultConditionBuilder() - Constructor for class org.ocpsoft.rewrite.config.DefaultConditionBuilder
 
DefaultOperationBuilder - Class in org.ocpsoft.rewrite.config
Used as a base class to create fluent relationships between Operation objects; this class adds logical operators to any class extending it.
DefaultOperationBuilder() - Constructor for class org.ocpsoft.rewrite.config.DefaultOperationBuilder
 
DefaultParameter - Class in org.ocpsoft.rewrite.param
A default implementation of Parameter.
DefaultParameter(String) - Constructor for class org.ocpsoft.rewrite.param.DefaultParameter
 
DefaultParameterStore - Class in org.ocpsoft.rewrite.param
Parameter store which retains the order, bindings, and names of parameters contained within.
DefaultParameterStore() - Constructor for class org.ocpsoft.rewrite.param.DefaultParameterStore
 
DefaultParameterValueStore - Class in org.ocpsoft.rewrite.param
Default implementation of ParameterValueStore
DefaultParameterValueStore() - Constructor for class org.ocpsoft.rewrite.param.DefaultParameterValueStore
Create a new, empty DefaultParameterValueStore instance.
DefaultParameterValueStore(DefaultParameterValueStore) - Constructor for class org.ocpsoft.rewrite.param.DefaultParameterValueStore
Create a new DefaultParameterValueStore instance, copying all Parameter and value pairs from the given instance.
define() - Static method in class org.ocpsoft.rewrite.config.RuleBuilder
Returns a new RuleBuilder instance.
define(String) - Static method in class org.ocpsoft.rewrite.config.RuleBuilder
Returns a new RuleBuilder instance, set with the given Rule ID.
Direction - Class in org.ocpsoft.rewrite.config
Responsible for evaluating Rewrite events on whether they are InboundRewrite or OutboundRewrite events.
Direction() - Constructor for class org.ocpsoft.rewrite.config.Direction
 
directoryExists(File) - Static method in class org.ocpsoft.rewrite.config.Filesystem
Create a Condition that returns true if the given File exists in the file-system of the host environment, and is a directory.

E

encodePath() - Static method in class org.ocpsoft.rewrite.util.Transpositions
 
enqueueSubmission(Rewrite, EvaluationContext, Parameter<?>, Object) - Static method in class org.ocpsoft.rewrite.util.ParameterUtils
Submit the given value to all registered Binding instances of the given Parameter.
entrySet() - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
equals(Object) - Method in class org.ocpsoft.rewrite.bind.Evaluation
 
equals(Object) - Method in class org.ocpsoft.rewrite.param.RegexConstraint
 
evaluate(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.And
 
evaluate(Rewrite, EvaluationContext) - Method in interface org.ocpsoft.rewrite.config.Condition
Evaluate this condition against the given Rewrite event.
evaluate(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
evaluate(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.False
 
evaluate(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.Filesystem
 
evaluate(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.Not
 
evaluate(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.Or
 
evaluate(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
evaluate(Configuration) - Static method in class org.ocpsoft.rewrite.config.Subset
 
evaluate(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.True
 
Evaluation - Class in org.ocpsoft.rewrite.bind
 
EvaluationContext - Interface in org.ocpsoft.rewrite.context
Context object spanning the lifecycle of a single Rule evaluation.

F

False - Class in org.ocpsoft.rewrite.config
Condition that always returns false.
False() - Constructor for class org.ocpsoft.rewrite.config.False
 
fileExists(File) - Static method in class org.ocpsoft.rewrite.config.Filesystem
Create a Condition that returns true if the given File exists in the file-system of the host environment, and is a normal file.
Filesystem - Class in org.ocpsoft.rewrite.config
A Condition responsible for determining existence of File paths on the host file-system.
Flow - Interface in org.ocpsoft.rewrite.event
Represents the current Rewrite event lifecycle state.

G

get(Object) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
get(Object) - Method in interface org.ocpsoft.rewrite.context.Context
Get the value in the context map defined by the given key.
get(Object) - Method in class org.ocpsoft.rewrite.context.ContextBase
 
get(String, Parameter<?>) - Method in class org.ocpsoft.rewrite.param.DefaultParameterStore
 
get(String) - Method in class org.ocpsoft.rewrite.param.DefaultParameterStore
 
get(String) - Method in interface org.ocpsoft.rewrite.param.ParameterStore
Get the Parameter with the given name.
get(String, Parameter<?>) - Method in interface org.ocpsoft.rewrite.param.ParameterStore
Retrieve the Parameter with the given name, otherwise use the default, if supplied.
get(Object) - Method in interface org.ocpsoft.rewrite.spi.RuleCacheProvider
Get Rule instances matching the given cache key.
get(Object) - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
getBegin() - Method in enum org.ocpsoft.rewrite.util.ParseTools.CaptureType
 
getBindings() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
getBindings() - Method in class org.ocpsoft.rewrite.param.ImmutableParameter
 
getBindings() - Method in interface org.ocpsoft.rewrite.param.Parameter
Retrieve all Binding instances to which this Parameter is bound.
getBindings() - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
getBuilder() - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternParser
Return the ParameterizedPatternBuilder corresponding to the pattern with which this ParameterizedPatternParser was constructed.
getBuilder() - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
 
getByConverterId(String) - Method in interface org.ocpsoft.rewrite.spi.ConverterProvider
Create a Converter by some unique ID.
getByConverterType(Class<?>) - Method in interface org.ocpsoft.rewrite.spi.ConverterProvider
Create a Converter by a third party converter class.
getByTargetType(Class<?>) - Method in interface org.ocpsoft.rewrite.spi.ConverterProvider
Create a Converter by a target type.
getByTargetType(Class<?>) - Method in interface org.ocpsoft.rewrite.spi.ValidatorProvider
Create a Validator by a target type.
getByValidatorId(String) - Method in interface org.ocpsoft.rewrite.spi.ValidatorProvider
Create a Validator by some unique ID.
getByValidatorType(Class<?>) - Method in interface org.ocpsoft.rewrite.spi.ValidatorProvider
Create a Validator by a third party Validator class.
getCaptured() - Method in class org.ocpsoft.rewrite.util.ParseTools.CapturingGroup
 
getCompiledPattern(ParameterStore) - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
 
getConditionBuilder() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
Return the underlying ConditionBuilder
getConditions() - Method in class org.ocpsoft.rewrite.config.And
 
getConditions() - Method in interface org.ocpsoft.rewrite.config.CompositeCondition
Returns all Condition objects contained within this CompositeCondition; otherwise, returns an empty List.
getConditions() - Method in class org.ocpsoft.rewrite.config.Not
 
getConditions() - Method in class org.ocpsoft.rewrite.config.Or
 
getConditions() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
getConfiguration(T) - Method in interface org.ocpsoft.rewrite.config.ConfigurationProvider
Return the additional configuration.
getConfiguration(T) - Method in interface org.ocpsoft.rewrite.spi.ConfigurationCacheProvider
Return the cached Configuration, or null of the cache is empty or unprimed.
getConstraints() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
getConstraints() - Method in class org.ocpsoft.rewrite.param.ImmutableParameter
 
getConstraints() - Method in interface org.ocpsoft.rewrite.param.Parameter
Get the underlying List of all Constraint objects currently registered to this Parameter.
getConstraints() - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
getConverter() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
getConverter() - Method in class org.ocpsoft.rewrite.param.ImmutableParameter
 
getConverter() - Method in interface org.ocpsoft.rewrite.param.Parameter
Get the Converter with which this Parameter will be converted.
getConverter() - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
getEnd() - Method in enum org.ocpsoft.rewrite.util.ParseTools.CaptureType
 
getEnd() - Method in class org.ocpsoft.rewrite.util.ParseTools.CapturingGroup
 
getEvaluatedRules() - Method in class org.ocpsoft.rewrite.AbstractRewrite
 
getEvaluatedRules() - Method in interface org.ocpsoft.rewrite.event.Rewrite
Returns the list of Rule instances that have been evaluated during this Rewrite event.
getExpression() - Method in class org.ocpsoft.rewrite.config.Filesystem
getFlow() - Method in interface org.ocpsoft.rewrite.event.Rewrite
Get the current lifecycle Flow.
getFullName() - Static method in class org.ocpsoft.rewrite.Version
 
getGroups(ParseTools.CaptureType, char[]) - Static method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
 
getId() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
getId() - Method in interface org.ocpsoft.rewrite.config.Rule
Get the ID for this Rule
getId() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
getIndex() - Method in exception org.ocpsoft.rewrite.param.ParameterizedPatternSyntaxException
Returns the index at which the error is located in the pattern, or -1 if the location is not known.
getInstance(EvaluationContext) - Static method in class org.ocpsoft.rewrite.param.DefaultParameterStore
Retrieve the current ParameterStore from the given EvaluationContext instance.
getInstance(EvaluationContext) - Static method in class org.ocpsoft.rewrite.param.DefaultParameterValueStore
Retrieve the current ParameterValueStore from the given EvaluationContext instance.
getInstance(Class<?>) - Method in interface org.ocpsoft.rewrite.spi.InstanceProvider
Get an instance of the given Class type.
getListValue(Map<String, List<T>>, String, int) - Static method in class org.ocpsoft.rewrite.util.Maps
 
getMessage() - Method in exception org.ocpsoft.rewrite.param.ParameterizedPatternSyntaxException
Returns a string containing the description of the syntax error and its location, the erroneous parameterized pattern string, and a visual location of the error index within the pattern (if possible.)
getName() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
getName() - Method in class org.ocpsoft.rewrite.param.ImmutableParameter
 
getName() - Method in interface org.ocpsoft.rewrite.param.Parameter
Get the name of this Parameter
getName() - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
getNegationCount(EvaluationContext) - Static method in class org.ocpsoft.rewrite.config.Conditions
Returns the number of "Not"s that have been evaluated in the current evaluation process.
getOperationBuilder() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
Return the underlying OperationBuilder
getOperations() - Method in interface org.ocpsoft.rewrite.config.CompositeOperation
Returns all Operation objects contained within this CompositeOperation; otherwise, returns an empty List.
getOperations() - Method in class org.ocpsoft.rewrite.config.Perform
 
getOperations() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
getOperations() - Method in class org.ocpsoft.rewrite.config.Subset
 
getParameters(EvaluationContext) - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternResult
Get the Map of Parameter instances that were referenced in the ParameterizedPattern.
getParameters() - Method in interface org.ocpsoft.rewrite.spi.GlobalParameterProvider
Return the Set of Parameter types to be added to the global Configuration.
getParameterStore() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
getParameterStore() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
getParameterStore() - Method in interface org.ocpsoft.rewrite.param.ParameterizedRule
Return the ParameterStore for this Rule
getParser() - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternBuilder
Return the ParameterizedPatternParser corresponding to the pattern with which this ParameterizedPatternBuilder was constructed.
getParser() - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
 
getPattern() - Method in interface org.ocpsoft.rewrite.param.ParameterizedPattern
Get the pattern for which this ParameterizedPattern represents.
getPattern() - Method in exception org.ocpsoft.rewrite.param.ParameterizedPatternSyntaxException
Returns the pattern containing errors.
getPattern() - Method in class org.ocpsoft.rewrite.param.RegexConstraint
 
getPattern() - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
 
getPattern() - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
 
getRequiredParameterNames() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
getRequiredParameterNames() - Method in class org.ocpsoft.rewrite.config.Filesystem
 
getRequiredParameterNames() - Method in class org.ocpsoft.rewrite.config.Log
 
getRequiredParameterNames() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
getRequiredParameterNames() - Method in class org.ocpsoft.rewrite.config.Subset
 
getRequiredParameterNames() - Method in interface org.ocpsoft.rewrite.param.Parameterized
Get all required Parameter names for this Parameterized instance.
getRequiredParameterNames() - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
 
getRequiredParameterNames() - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
 
getRewriteContext() - Method in class org.ocpsoft.rewrite.AbstractRewrite
 
getRewriteContext() - Method in interface org.ocpsoft.rewrite.event.Rewrite
Get the Context object associated with this Rewrite event.
getRuleBuilder() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
Provides access to the RuleBuilder for the current Rule.
getRuleBuilders() - Method in class org.ocpsoft.rewrite.config.ConfigurationBuilder
 
getRuleBuilders() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
getRules() - Method in interface org.ocpsoft.rewrite.config.CompositeRule
Returns a list of Rule instances contained by this CompositeRule.
getRules() - Method in interface org.ocpsoft.rewrite.config.Configuration
Get the list of Rule instances defined by this Configuration
getRules() - Method in class org.ocpsoft.rewrite.config.ConfigurationBuilder
 
getRules() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
getRules() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
getRules() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
getStart() - Method in class org.ocpsoft.rewrite.util.ParseTools.CapturingGroup
 
getState() - Method in interface org.ocpsoft.rewrite.context.EvaluationContext
Return the current RewriteState for this EvaluationContext.
getTranspositions() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
getTranspositions() - Method in class org.ocpsoft.rewrite.param.ImmutableParameter
 
getTranspositions() - Method in interface org.ocpsoft.rewrite.param.Parameter
Get the underlying List of all Transposition objects currently registered to this Parameter.
getTranspositions() - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
getValidator() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
getValidator() - Method in class org.ocpsoft.rewrite.param.ImmutableParameter
 
getValidator() - Method in interface org.ocpsoft.rewrite.param.Parameter
Get the Validator with which this Parameter will be validated.
getValidator() - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
getVersion() - Static method in class org.ocpsoft.rewrite.Version
 
GlobalParameterProvider - Interface in org.ocpsoft.rewrite.spi
SPI for providing pre-configured global Parameter types.

H

handle(Rewrite, EvaluationContext, Object) - Method in interface org.ocpsoft.rewrite.spi.InvocationResultHandler
Handle return value from Binding result obtained during an Invoke operation.
hashCode() - Method in class org.ocpsoft.rewrite.bind.Evaluation
 
hashCode() - Method in class org.ocpsoft.rewrite.param.RegexConstraint
 
hasValue(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.bind.Evaluation
 

I

identity() - Static method in class org.ocpsoft.rewrite.util.Transpositions
 
ImmutableParameter - Class in org.ocpsoft.rewrite.param
A an immutable implementation of Parameter.
ImmutableParameter(Parameter<?>) - Constructor for class org.ocpsoft.rewrite.param.ImmutableParameter
 
InboundRewrite - Interface in org.ocpsoft.rewrite.event
Defines a Rewrite event that is in the inbound direction.
init(C) - Method in interface org.ocpsoft.rewrite.spi.RewriteProvider
Initialize this RewriteProvider
initialize(EvaluationContext, Object) - Static method in class org.ocpsoft.rewrite.util.ParameterUtils
Initialize the Parameterized instance with the ParameterStore from the given EvaluationContext, also record required parameter names in the ParameterStore and initialize with a new Parameter instance.
initialize(ParameterStore, Object) - Static method in class org.ocpsoft.rewrite.util.ParameterUtils
Initialize the Parameterized instance with the given ParameterStore, also record required parameter names in the ParameterStore and initialize with a new Parameter instance.
InstanceProvider - Interface in org.ocpsoft.rewrite.spi
Responsible for performing object instance lookups.
Instances - Class in org.ocpsoft.rewrite.util
Utility class for looking up instances of Java types.
InvocationResultHandler - Interface in org.ocpsoft.rewrite.spi
Handles return values from Binding results obtained during an Invoke operation.
Invoke - Class in org.ocpsoft.rewrite.config
Builds Operation instances used to directly invoke Binding submission or retrieval on Rewrite events.
is(Flow) - Method in interface org.ocpsoft.rewrite.event.Flow
Return true if this Flow is equivalent to the given instance.
isEmpty() - Method in class org.ocpsoft.rewrite.param.DefaultParameterStore
 
isEmpty() - Method in interface org.ocpsoft.rewrite.param.ParameterStore
Return true if this ParameterStore is empty, otherwise return false.
isEmpty() - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
isEscaped(char[], int) - Static method in class org.ocpsoft.rewrite.util.ParseTools
Return true if the character at the given cursor is escaped; otherwise, return false.
isEvaluating() - Method in enum org.ocpsoft.rewrite.context.RewriteState
Return true if this instance is equal to RewriteState.EVALUATING.
isHandled() - Method in interface org.ocpsoft.rewrite.event.Flow
Return true if this Flow represents a handled state.
isInbound() - Static method in class org.ocpsoft.rewrite.config.Direction
Returns a new Condition that returns true when operating on an InboundRewrite event.
isNegated(EvaluationContext) - Static method in class org.ocpsoft.rewrite.config.Conditions
Indicates whether the current Condition is being negated.
isOutbound() - Static method in class org.ocpsoft.rewrite.config.Direction
Returns a new Condition that returns true when operating on an OutboundRewrite event.
isParameterComplete(Rewrite, EvaluationContext) - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternBuilder
Returns true if all parameters required by this builder are available; otherwise, returns false.
isParameterComplete(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
 
isPerforming() - Method in enum org.ocpsoft.rewrite.context.RewriteState
Return true if this instance is equal to RewriteState.PERFORMING.
isRelocated() - Method in interface org.ocpsoft.rewrite.config.Relocatable
Returns true if this object should be relocated, or has been relocated.
isRelocated() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
isSatisfiedBy(Rewrite, EvaluationContext, T) - Method in interface org.ocpsoft.rewrite.param.Constraint
Return true if this Constraint is satisfied by the given value; otherwise, return false.
isSatisfiedBy(Rewrite, EvaluationContext, String) - Method in class org.ocpsoft.rewrite.param.RegexConstraint
 
isSatisfiedBy(Rewrite, EvaluationContext, String) - Method in class org.ocpsoft.rewrite.transposition.LocaleTransposition
 
isValid(Rewrite, EvaluationContext, Parameter<?>, String) - Method in class org.ocpsoft.rewrite.param.DefaultParameterValueStore
 
isValid(Rewrite, EvaluationContext) - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternResult
Validate all Parameter values defined within the original ParameterizedPattern.
isValid(Rewrite, EvaluationContext, Parameter<?>, String) - Method in interface org.ocpsoft.rewrite.param.ParameterValueStore
Validate the given Parameter and value.
isValid(Rewrite, EvaluationContext, T) - Method in interface org.ocpsoft.rewrite.param.Validator
Return true if the given value is valid; otherwise return false.
isValid(Rewrite, EvaluationContext, Parameter<?>, String) - Method in interface org.ocpsoft.rewrite.spi.GlobalParameterProvider
Validate the given Parameter.
iterator() - Method in class org.ocpsoft.rewrite.param.DefaultParameterStore
 
iterator() - Method in class org.ocpsoft.rewrite.param.DefaultParameterValueStore
 

K

keySet() - Method in class org.ocpsoft.rewrite.util.CompositeMap
 

L

loadConfiguration(Object) - Method in class org.ocpsoft.rewrite.config.ConfigurationLoader
Load all ConfigurationProvider instances, sort by Weighted.priority(), and return a unified, composite Configuration object.
LocaleTransposition - Class in org.ocpsoft.rewrite.transposition
A Transposition and/or Constraint responsible for translating values from their matching translation from a ResourceBundle.
log - Static variable in class org.ocpsoft.rewrite.config.ConfigurationLoader
 
Log - Class in org.ocpsoft.rewrite.config
An Operation responsible for logging a message.
logEvaluatedRules(Rewrite, Logger.Level) - Static method in class org.ocpsoft.rewrite.AbstractRewrite
Print a log of all Rule instances evaluated during the given Rewrite event.
logLoadedServices(Logger, Class<T>, List<? extends T>) - Static method in class org.ocpsoft.rewrite.util.ServiceLogger
 
lookup(Class<T>) - Static method in class org.ocpsoft.rewrite.util.Instances
Lookup an instance of the given Class type.

M

Maps - Class in org.ocpsoft.rewrite.util
 
Maps() - Constructor for class org.ocpsoft.rewrite.util.Maps
 
matches(String) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleParameter
Configure the regular expression Pattern to which this Parameter must match.
matches(String) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
matches(String) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleParameterWhere
Configure the regular expression Pattern to which this Parameter must match.
matches() - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternResult
Returns true if the ParameterizedPattern matched the input value, false if not.
message(Logger.Level, String) - Static method in class org.ocpsoft.rewrite.config.Log
Log a message at the given Logger.Level.

N

NEGATION_COUNT_KEY - Static variable in class org.ocpsoft.rewrite.config.Conditions
 
NoOp - Class in org.ocpsoft.rewrite.config
An OperationBuilder that does nothing.
NoOp() - Constructor for class org.ocpsoft.rewrite.config.NoOp
 
Not - Class in org.ocpsoft.rewrite.config
Evaluates all provided Condition instances.

O

onInbound(Operation) - Static method in class org.ocpsoft.rewrite.config.Operations
Wrap the given Operation in a new InboundOperation which will invoke the wrapped operation only for inbound rewrites.
onOutbound(Operation) - Static method in class org.ocpsoft.rewrite.config.Operations
Wrap the given Operation in a new Operation which will invoke the wrapped operation only for outbound rewrites.
onTranspositionFailed(Operation) - Method in class org.ocpsoft.rewrite.transposition.LocaleTransposition
Specify an Operation to be added as a preOperation in case the Transposition failed.
Operation - Interface in org.ocpsoft.rewrite.config
Defines an operation to be performed after successful evaluation a Rewrite event.
OperationBuilder - Interface in org.ocpsoft.rewrite.config
An Operation capable of appending additional Operation objects.
Operations - Class in org.ocpsoft.rewrite.config
Utility for creating and wrapping Operation instances.
Operations() - Constructor for class org.ocpsoft.rewrite.config.Operations
 
operationToString() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
OperationVisit - Class in org.ocpsoft.rewrite.config
This class allows Visitors to walk through an Operation tree which may contain CompositeOperation elements.
OperationVisit(Operation) - Constructor for class org.ocpsoft.rewrite.config.OperationVisit
Initialize class with the supplied root Operation
or(Condition) - Method in interface org.ocpsoft.rewrite.config.ConditionBuilder
Append a new Condition to this builder.
or(Condition) - Method in class org.ocpsoft.rewrite.config.DefaultConditionBuilder
 
Or - Class in org.ocpsoft.rewrite.config
Evaluates all provided Condition instances.
org.ocpsoft.rewrite - package org.ocpsoft.rewrite
 
org.ocpsoft.rewrite.bind - package org.ocpsoft.rewrite.bind
 
org.ocpsoft.rewrite.config - package org.ocpsoft.rewrite.config
 
org.ocpsoft.rewrite.context - package org.ocpsoft.rewrite.context
 
org.ocpsoft.rewrite.event - package org.ocpsoft.rewrite.event
 
org.ocpsoft.rewrite.exception - package org.ocpsoft.rewrite.exception
 
org.ocpsoft.rewrite.param - package org.ocpsoft.rewrite.param
 
org.ocpsoft.rewrite.spi - package org.ocpsoft.rewrite.spi
 
org.ocpsoft.rewrite.transposition - package org.ocpsoft.rewrite.transposition
 
org.ocpsoft.rewrite.util - package org.ocpsoft.rewrite.util
 
orNot(Condition) - Method in interface org.ocpsoft.rewrite.config.ConditionBuilder
Append a new Condition to this builder.
orNot(Condition) - Method in class org.ocpsoft.rewrite.config.DefaultConditionBuilder
 
otherwise(Operation) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
otherwise(Operation, Operation...) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
otherwise(Operation) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderPerform
Perform the given Operation when the conditions set in this Rule fail to be met.
otherwise(Operation, Operation...) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderPerform
Perform the given Operation instances when the conditions set in this Rule fail to be met.
otherwise(Operation) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderWhen
Perform the given Operation when the conditions set in this Rule fail to be met.
otherwise(Operation, Operation...) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderWhen
Perform the given Operation instances when the conditions set in this Rule fail to be met.
otherwise(Operation) - Method in interface org.ocpsoft.rewrite.spi.ConfigurationRuleBuilderInterceptor
Intercept, modify, or replace the given Operation
otherwise(List<Operation>) - Method in interface org.ocpsoft.rewrite.spi.ConfigurationRuleBuilderInterceptor
Intercept, modify, or replace the given Operation instances
OutboundRewrite - Interface in org.ocpsoft.rewrite.event
Defines a Rewrite event that is in the outbound direction.

P

Parameter<IMPLTYPE extends Parameter<IMPLTYPE>> - Interface in org.ocpsoft.rewrite.param
Provides metadata for handling parameter behavior in Parameterized Condition, Operation, and Rule instances.
ParameterBuilder<IMPLTYPE extends ParameterBuilder<IMPLTYPE>> - Class in org.ocpsoft.rewrite.param
An base implementation of Parameter
ParameterBuilder(String) - Constructor for class org.ocpsoft.rewrite.param.ParameterBuilder
Create a new ParameterBuilder instance with the given name.
ParameterConfiguration<IMPLTYPE extends ParameterConfiguration<IMPLTYPE>> - Interface in org.ocpsoft.rewrite.param
The set of mutators for configuring Parameter instances.
ParameterConfigurator - Interface in org.ocpsoft.rewrite.param
Marker interface for any object types that are used in the ParameterConfiguration interface.
ParameterizationException - Exception in org.ocpsoft.rewrite.exception
Thrown when a ParameterizedPattern error has occurred.
ParameterizationException(String, Throwable) - Constructor for exception org.ocpsoft.rewrite.exception.ParameterizationException
 
ParameterizationException(String) - Constructor for exception org.ocpsoft.rewrite.exception.ParameterizationException
 
Parameterized - Interface in org.ocpsoft.rewrite.param
Represents an object which may be parameterized and bound.
ParameterizedCallback - Interface in org.ocpsoft.rewrite.config
ParameterizedConditionVisitor - Class in org.ocpsoft.rewrite.config
Visitor implementation for Conditions that executes a given callback for all conditions that provide a specific parameter.
ParameterizedConditionVisitor(ParameterizedCallback) - Constructor for class org.ocpsoft.rewrite.config.ParameterizedConditionVisitor
 
ParameterizedOperationVisitor - Class in org.ocpsoft.rewrite.config
Visitor implementation for Operations that executes a given callback for all operations that provide a specific parameter.
ParameterizedOperationVisitor(ParameterizedCallback) - Constructor for class org.ocpsoft.rewrite.config.ParameterizedOperationVisitor
 
ParameterizedPattern - Interface in org.ocpsoft.rewrite.param
A Parameterized pattern (template) that may be used to parse or generate String instances.
ParameterizedPatternBuilder - Interface in org.ocpsoft.rewrite.param
A Parameterized regular expression Pattern.
ParameterizedPatternParser - Interface in org.ocpsoft.rewrite.param
A Parameterized regular expression Pattern.
ParameterizedPatternResult - Interface in org.ocpsoft.rewrite.param
Stores the result of ParameterizedPatternParser#matches(Rewrite, EvaluationContext, String).
ParameterizedPatternSyntaxException - Exception in org.ocpsoft.rewrite.param
Thrown when a syntax error is found in a ParameterizedPattern.
ParameterizedPatternSyntaxException(String, String, int) - Constructor for exception org.ocpsoft.rewrite.param.ParameterizedPatternSyntaxException
ParameterizedRule - Interface in org.ocpsoft.rewrite.param
Represents a Rule that has a ParameterStore.
Parameters - Class in org.ocpsoft.rewrite.param
Utility for extracting values from the ParameterValueStore.
Parameters() - Constructor for class org.ocpsoft.rewrite.param.Parameters
 
ParameterStore - Interface in org.ocpsoft.rewrite.param
A store which retains the central index of Parameter instances for Rule configuraion.
ParameterUtils - Class in org.ocpsoft.rewrite.util
Utility methods for interactive with ParameterStore instances.
ParameterUtils() - Constructor for class org.ocpsoft.rewrite.util.ParameterUtils
 
ParameterValueStore - Interface in org.ocpsoft.rewrite.param
Used to submit Parameter values in String form.
parse(String) - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternParser
Return a ParameterizedPatternResult for the evaluation of this ParameterizedPattern against the given String.
parse(String) - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
 
ParseTools - Class in org.ocpsoft.rewrite.util
 
ParseTools() - Constructor for class org.ocpsoft.rewrite.util.ParseTools
 
ParseTools.CaptureType - Enum in org.ocpsoft.rewrite.util
 
ParseTools.CapturingGroup - Class in org.ocpsoft.rewrite.util
 
perform(Operation) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
perform(Operation, Operation...) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
perform(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
perform(Operation) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderCustom
Perform the given Operation when the conditions set in this Rule are met.
perform(Operation, Operation...) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderCustom
Perform the given Operation instances when the conditions set in this Rule are met.
perform(Operation) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderWhen
Perform the given Operation when the conditions set in this Rule are met.
perform(Operation, Operation...) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderWhen
Perform the given Operation instances when the conditions set in this Rule are met.
perform(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.Invoke
 
perform(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.Log
 
perform(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.NoOp
 
perform(Rewrite, EvaluationContext) - Method in interface org.ocpsoft.rewrite.config.Operation
Perform the Operation.
Perform - Class in org.ocpsoft.rewrite.config
Evaluates all provided Operation instances.
perform(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.Perform
 
perform(Operation) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
Perform the given Operation when the conditions set in this Rule are met.
perform(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
perform(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.config.Subset
 
perform(Operation) - Method in interface org.ocpsoft.rewrite.spi.ConfigurationRuleBuilderInterceptor
Intercept, modify, or replace the given Operation
perform(List<Operation>) - Method in interface org.ocpsoft.rewrite.spi.ConfigurationRuleBuilderInterceptor
Intercept, modify, or replace the given Operation instances
performRetrieval(Rewrite, EvaluationContext, Parameter<?>) - Static method in class org.ocpsoft.rewrite.util.ParameterUtils
Extract bound values from configured Parameter instances.
priority() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
property(String) - Static method in class org.ocpsoft.rewrite.bind.Evaluation
 
PROVIDER_LOCATION - Static variable in interface org.ocpsoft.rewrite.config.RuleMetadata
The location where the Rule was added to the ConfigurationBuilder.
put(Object, Object) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
put(Object, Object) - Method in interface org.ocpsoft.rewrite.context.Context
Store a key value pair into the context.
put(Object, Object) - Method in class org.ocpsoft.rewrite.context.ContextBase
 
put(Object, List<Rule>) - Method in interface org.ocpsoft.rewrite.spi.RuleCacheProvider
Store a list of Rule instances matching the given cache key.
put(KEYTYPE, VALUETYPE) - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
putAll(Map<? extends KEYTYPE, ? extends VALUETYPE>) - Method in class org.ocpsoft.rewrite.util.CompositeMap
 

R

RegexConstraint - Class in org.ocpsoft.rewrite.param
Defines a Constraint using a regular expression.
RegexConstraint(String) - Constructor for class org.ocpsoft.rewrite.param.RegexConstraint
Create a new RegexConstraint using the given pattern.
RegexParameterizedPatternBuilder - Class in org.ocpsoft.rewrite.param
An Parameterized regular expression Pattern.
RegexParameterizedPatternBuilder(String) - Constructor for class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
Create a new RegexParameterizedPatternBuilder instance with the default org.ocpsoft.rewrite.bind.parse.CaptureType#BRACE and parameter compiledPattern of ".*".
RegexParameterizedPatternBuilder(String, String) - Constructor for class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
Create a new RegexParameterizedPatternBuilder instance with the default ParseTools.CaptureType.BRACE.
RegexParameterizedPatternBuilder(ParseTools.CaptureType, String) - Constructor for class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
Create a new RegexParameterizedPatternBuilder instance with the default parameter regex of ".*".
RegexParameterizedPatternBuilder(ParseTools.CaptureType, String, String) - Constructor for class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
Create a new RegexParameterizedPatternBuilder instance.
RegexParameterizedPatternParser - Class in org.ocpsoft.rewrite.param
An Parameterized regular expression Pattern.
RegexParameterizedPatternParser(String) - Constructor for class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
Create a new RegexParameterizedPatternParser instance with the default org.ocpsoft.rewrite.bind.parse.CaptureType#BRACE and parameter pattern of ".*".
RegexParameterizedPatternParser(String, String) - Constructor for class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
Create a new RegexParameterizedPatternParser instance with the default ParseTools.CaptureType.BRACE.
RegexParameterizedPatternParser(ParseTools.CaptureType, String) - Constructor for class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
Create a new RegexParameterizedPatternParser instance with the default parameter regex of ".*".
RegexParameterizedPatternParser(ParseTools.CaptureType, String, String) - Constructor for class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
Create a new RegexParameterizedPatternParser instance.
Relocatable - Interface in org.ocpsoft.rewrite.config
Defines a contract where a given object can be relocated to a new position in a data-structure.
RelocatableRule - Interface in org.ocpsoft.rewrite.config
Defines a Relocatable Rule, which can be moved to a priority position in the compiled rule set that differs from the ConfigurationProvider in which it was created.
remove(Object) - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
Retrieval - Interface in org.ocpsoft.rewrite.bind
Defines the methods necessary to perform Binding value retrieval.
retrieve(Rewrite, EvaluationContext) - Method in class org.ocpsoft.rewrite.bind.Evaluation
 
retrieve(Rewrite, EvaluationContext) - Method in interface org.ocpsoft.rewrite.bind.Retrieval
Retrieve the value from its storage location.
retrieve(Parameter<?>) - Method in class org.ocpsoft.rewrite.param.DefaultParameterValueStore
 
retrieve(EvaluationContext, String) - Static method in class org.ocpsoft.rewrite.param.Parameters
Retrieve a single parameter value from the ParameterValueStore.
retrieve(Parameter<?>) - Method in interface org.ocpsoft.rewrite.param.ParameterValueStore
Retrieve the currenet value for the given Parameter.
retrieveConverted(Rewrite, EvaluationContext, Parameter<?>) - Method in class org.ocpsoft.rewrite.bind.Evaluation
 
Rewrite - Interface in org.ocpsoft.rewrite.event
Event propagated to registered RewriteLifecycleListener and RewriteProvider instances when the rewrite lifecycle is executed.
rewrite(T) - Method in interface org.ocpsoft.rewrite.spi.RewriteProvider
Handle the given Rewrite event.
RewriteException - Exception in org.ocpsoft.rewrite.exception
Exception thrown by the Rewrite framework.
RewriteException(String, Throwable) - Constructor for exception org.ocpsoft.rewrite.exception.RewriteException
 
RewriteException(String) - Constructor for exception org.ocpsoft.rewrite.exception.RewriteException
 
RewriteProvider<C,T extends Rewrite> - Interface in org.ocpsoft.rewrite.spi
SPI for Rewrite event handling.
RewriteState - Enum in org.ocpsoft.rewrite.context
Represents the the current Rewrite state during Rule execution.
Rule - Interface in org.ocpsoft.rewrite.config
Encapsulates correlated Condition and Operation instances.
RuleBuilder - Class in org.ocpsoft.rewrite.config
Builder for fluently defining new composite Rule instances.
RuleCacheProvider - Interface in org.ocpsoft.rewrite.spi
SPI for implementing Rule caching.
RuleMetadata - Interface in org.ocpsoft.rewrite.config
Defines a set of constants for accessing Rule metadata.
RuleVisit - Class in org.ocpsoft.rewrite.config
This class allows Visitor instances to walk through a Rule tree which may contain CompositeCondition or CompositeOperation elements containing other rules.
RuleVisit(Rule) - Constructor for class org.ocpsoft.rewrite.config.RuleVisit
Initialize class with the supplied root Rule

S

ServiceLogger - Class in org.ocpsoft.rewrite.util
 
ServiceLogger() - Constructor for class org.ocpsoft.rewrite.util.ServiceLogger
 
setConfiguration(T, Configuration) - Method in interface org.ocpsoft.rewrite.spi.ConfigurationCacheProvider
Store the given Configuration into the cache for later retrieval.
setParameterStore(ParameterStore) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
setParameterStore(ParameterStore) - Method in class org.ocpsoft.rewrite.config.Filesystem
 
setParameterStore(ParameterStore) - Method in class org.ocpsoft.rewrite.config.Log
 
setParameterStore(ParameterStore) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
setParameterStore(ParameterStore) - Method in class org.ocpsoft.rewrite.config.Subset
 
setParameterStore(ParameterStore) - Method in interface org.ocpsoft.rewrite.param.Parameterized
Initialize this Parameterized instance with the global ParameterStore.
setParameterStore(ParameterStore) - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
 
setParameterStore(ParameterStore) - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
 
shutdown(C) - Method in interface org.ocpsoft.rewrite.spi.RewriteProvider
Shut down this RewriteProvider
size() - Method in class org.ocpsoft.rewrite.param.DefaultParameterStore
 
size() - Method in interface org.ocpsoft.rewrite.param.ParameterStore
Return the number of Parameter instances in this ParameterStore.
size() - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
store(Parameter<?>) - Method in class org.ocpsoft.rewrite.param.DefaultParameterStore
 
Submission - Interface in org.ocpsoft.rewrite.bind
Defines the methods necessary to perform, converted, validated Binding value submission.
submit(Rewrite, EvaluationContext, Object) - Method in class org.ocpsoft.rewrite.bind.Evaluation
 
submit(Rewrite, EvaluationContext, Object) - Method in interface org.ocpsoft.rewrite.bind.Submission
Store a value into the designated storage location.
submit(Rewrite, EvaluationContext, Parameter<?>, String) - Method in class org.ocpsoft.rewrite.param.DefaultParameterValueStore
 
submit(Rewrite, EvaluationContext) - Method in interface org.ocpsoft.rewrite.param.ParameterizedPatternResult
Submit all Parameter values to the ParameterValueStore, only if the values are match a prior value or have not yet had a value set.
submit(Rewrite, EvaluationContext, Parameter<?>, String) - Method in interface org.ocpsoft.rewrite.param.ParameterValueStore
Submit the given Parameter and value.
submitConverted(Rewrite, EvaluationContext, Object) - Method in class org.ocpsoft.rewrite.bind.Evaluation
 
Subset - Class in org.ocpsoft.rewrite.config
An Operation that allows for conditional evaluation of nested Rule sets.
supportsRetrieval() - Method in interface org.ocpsoft.rewrite.bind.Binding
Return true if this Binding support retrieval.
supportsRetrieval() - Method in class org.ocpsoft.rewrite.bind.Evaluation
 
supportsSubmission() - Method in interface org.ocpsoft.rewrite.bind.Binding
Return true if this Binding supports submission.
supportsSubmission() - Method in class org.ocpsoft.rewrite.bind.Evaluation
 
supportsSubmission(Rewrite, EvaluationContext, Parameter<?>) - Method in interface org.ocpsoft.rewrite.spi.GlobalParameterProvider
Return true if the given Parameter supports value submission.

T

toArrayMap(Map<String, List<String>>) - Static method in class org.ocpsoft.rewrite.util.Maps
 
toString() - Method in class org.ocpsoft.rewrite.bind.Evaluation
 
toString() - Method in class org.ocpsoft.rewrite.config.And
 
toString() - Method in class org.ocpsoft.rewrite.config.ConfigurationBuilder
 
toString() - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
toString() - Method in class org.ocpsoft.rewrite.config.False
 
toString() - Method in class org.ocpsoft.rewrite.config.Invoke
 
toString() - Method in class org.ocpsoft.rewrite.config.Log
 
toString() - Method in class org.ocpsoft.rewrite.config.NoOp
 
toString() - Method in class org.ocpsoft.rewrite.config.Not
 
toString() - Method in class org.ocpsoft.rewrite.config.Or
 
toString() - Method in class org.ocpsoft.rewrite.config.Perform
 
toString() - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
toString() - Method in class org.ocpsoft.rewrite.config.Subset
 
toString() - Method in class org.ocpsoft.rewrite.config.True
 
toString() - Method in class org.ocpsoft.rewrite.context.ContextBase
 
toString() - Method in class org.ocpsoft.rewrite.param.DefaultParameterStore
 
toString() - Method in class org.ocpsoft.rewrite.param.DefaultParameterValueStore
 
toString() - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
toString() - Method in class org.ocpsoft.rewrite.param.RegexConstraint
 
toString() - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternBuilder
 
toString() - Method in class org.ocpsoft.rewrite.param.RegexParameterizedPatternParser
 
toString() - Method in class org.ocpsoft.rewrite.util.ParseTools.CapturingGroup
 
transpose(Rewrite, EvaluationContext, S) - Method in interface org.ocpsoft.rewrite.param.Transposition
Perform an operation on the given value.
transpose(Rewrite, EvaluationContext, String) - Method in class org.ocpsoft.rewrite.transposition.LocaleTransposition
 
transposedBy(Transposition<String>) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
transposedBy(Transposition<String>) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleParameterMatches
Add a Transposition to this IMPLTYPE; it will executed in the order in which it was added.
transposedBy(Transposition<String>) - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
transposedBy(Transposition<String>) - Method in interface org.ocpsoft.rewrite.param.ParameterConfiguration
Add a Transposition to this ParameterConfiguration; it will executed in the order in which it was added.
Transposition<S> - Interface in org.ocpsoft.rewrite.param
Used to modify Parameter values after they have been verified by the Constraint API.
Transpositions - Class in org.ocpsoft.rewrite.util
This class provides common implementations of the Transposition interface.
Transpositions() - Constructor for class org.ocpsoft.rewrite.util.Transpositions
 
True - Class in org.ocpsoft.rewrite.config
Condition that always returns true.
True() - Constructor for class org.ocpsoft.rewrite.config.True
 

V

validatedBy(Validator<?>) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
validatedBy(Validator<?>) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleParameterMatches
Set the Validator with which this Parameter value will be validated.
validatedBy(Validator<?>) - Method in class org.ocpsoft.rewrite.param.ParameterBuilder
 
validatedBy(Validator<?>) - Method in interface org.ocpsoft.rewrite.param.ParameterConfiguration
Set the Validator with which this ParameterConfiguration value will be validated.
validates(Rewrite, EvaluationContext, Validator<?>, Object) - Static method in class org.ocpsoft.rewrite.util.ValueHolderUtil
 
Validator<T> - Interface in org.ocpsoft.rewrite.param
Used to validate Parameter values after they have been converted via the Converter API.
ValidatorProvider - Interface in org.ocpsoft.rewrite.spi
SPI for providing integration with other validation frameworks.
ValueHolderUtil - Class in org.ocpsoft.rewrite.util
Utility for interacting with Validator and Converter instances.
ValueHolderUtil() - Constructor for class org.ocpsoft.rewrite.util.ValueHolderUtil
 
valueOf(String) - Static method in enum org.ocpsoft.rewrite.context.RewriteState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ocpsoft.rewrite.util.ParseTools.CaptureType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.ocpsoft.rewrite.context.RewriteState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class org.ocpsoft.rewrite.util.CompositeMap
 
values() - Static method in enum org.ocpsoft.rewrite.util.ParseTools.CaptureType
Returns an array containing the constants of this enum type, in the order they are declared.
Version - Class in org.ocpsoft.rewrite
Helper class to read the version of Rewrite
Version() - Constructor for class org.ocpsoft.rewrite.Version
 
visit(Condition) - Method in class org.ocpsoft.rewrite.config.ParameterizedConditionVisitor
 
visit(Operation) - Method in class org.ocpsoft.rewrite.config.ParameterizedOperationVisitor
 
visit(E) - Method in interface org.ocpsoft.rewrite.util.Visitor
Visit the supplied object
Visitor<E> - Interface in org.ocpsoft.rewrite.util
General purpose visitor interface

W

when(Condition) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
when(Condition, Condition...) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
when(Condition) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderCustom
Set the Condition of this Rule instance.
when(Condition, Condition...) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderCustom
Set the Conditions of this Rule instance.
when(Condition) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
Set the Condition of this Rule instance.
when(Condition) - Method in interface org.ocpsoft.rewrite.spi.ConfigurationRuleBuilderInterceptor
Intercept, modify, or replace the given Condition
when(List<Condition>) - Method in interface org.ocpsoft.rewrite.spi.ConfigurationRuleBuilderInterceptor
Intercept, modify, or replace the given Condition instances
where(String) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
where(String) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderOtherwise
Configure the Parameter with the given name.
where(String) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderPerform
Configure the Parameter with the given name.
where(String) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
where(String) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleParameterMatches
Configure the Parameter with the given name.
where(String) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
 
withId(String) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
withId(String) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderOtherwise
Set the ID for the current Rule.
withId(String) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderPerform
Set the ID for the current Rule.
withId(String) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderWithPriority
Set the ID for the current Rule.
withId(String) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
withId(String) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
Set the ID of this Rule instance.
withId(String) - Method in interface org.ocpsoft.rewrite.spi.ConfigurationRuleBuilderInterceptor
Intercept, modify, or replace the given ID
withMetadata(Object, Object) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
withMetadata(Object, Object) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderWithMetadata
Specify additional meta-data to be associated with this Rule.
withMetadata(Object, Object) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
withPriority(int) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleBuilder
 
withPriority(int) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderOtherwise
Set the priority of this Rule instance.
withPriority(int) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderPerform
Set the priority of this Rule instance.
withPriority(int) - Method in interface org.ocpsoft.rewrite.config.ConfigurationRuleBuilderWithId
Set the priority of this Rule instance.
withPriority(int) - Method in class org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder
 
withPriority(int) - Method in class org.ocpsoft.rewrite.config.RuleBuilder
Set the priority of this Rule instance.
withPriority(int) - Method in interface org.ocpsoft.rewrite.spi.ConfigurationRuleBuilderInterceptor
Intercept, modify, or replace the given priority
wrap(Condition) - Static method in class org.ocpsoft.rewrite.config.Conditions
Wrap a given Condition as a new DefaultConditionBuilder that evaluates the the original Condition when #evaluate(Rewrite, EvaluationContext) is invoked.
wrap(Operation) - Static method in class org.ocpsoft.rewrite.config.Operations
Wrap a given Operation as a new DefaultOperationBuilder that performs the action of the original Operation when #perform(Rewrite, EvaluationContext) is invoked.
wrap(Rule) - Static method in class org.ocpsoft.rewrite.config.RuleBuilder
Returns a new RuleBuilder instance wrapping the given Rule.
A B C D E F G H I K L M N O P R S T V W 
Skip navigation links
rewrite-api 3.5.0.Final

Copyright © 2021 OCPsoft. All rights reserved.