ConfigurationRuleParameterBuilder (rewrite-api 3.5.2.Final API)

java.lang.Object
- org.ocpsoft.rewrite.config.ConfigurationRuleParameterBuilder

All Implemented Interfaces:

Configuration, ConfigurationBuilderRoot, ConfigurationRuleBuilderOtherwise, ConfigurationRuleBuilderWithMetadata, ConfigurationRuleParameter, ConfigurationRuleParameterMatches, ConfigurationRuleParameterWhere, ConfigurableParameter<ConfigurationRuleParameterBuilder>, Parameter<ConfigurationRuleParameterBuilder>, ParameterConfiguration<ConfigurationRuleParameterBuilder>
```
public class ConfigurationRuleParameterBuilder
extends Object
implements ConfigurableParameter<ConfigurationRuleParameterBuilder>, ConfigurationRuleParameter, ConfigurationRuleParameterMatches, ConfigurationRuleParameterWhere, ConfigurationRuleBuilderOtherwise
```
A ParameterBuilder for a ConfigurationRuleBuilder

Author:

Lincoln Baxter, III

Constructor Summary

Constructors
Constructor and Description

ConfigurationRuleParameterBuilder(ConfigurationRuleBuilder parent, ConfigurableParameter<?> param)

Constructors
Constructor and Description
`ConfigurationRuleParameterBuilder(ConfigurationRuleBuilder parent, ConfigurableParameter<?> param)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConfigurationRuleBuilderCustom`	`addRule()` Define a new fluent `Rule`.
`ConfigurationRuleBuilder`	`addRule(Rule rule)` Add a pre-defined `Rule`.
`ConfigurationRuleParameterBuilder`	`bindsTo(Binding binding)` Add a `Binding` to this `ParameterConfiguration`.
`ConfigurationRuleParameterBuilder`	`configuredBy(ParameterConfigurator configurator)` Add a `ParameterConfigurator` with which this `ParameterConfiguration` will be configured.
`ConfigurationRuleParameterBuilder`	`constrainedBy(Constraint<String> constraint)` Add a constraint to which this `ParameterConfiguration` must match.
`ConfigurationRuleParameterBuilder`	`convertedBy(Converter<?> converter)` Set the `Converter` with which this `ParameterConfiguration` value will be converted.
`List<Binding>`	`getBindings()` Retrieve all `Binding` instances to which this `Parameter` is bound.
`List<Constraint<String>>`	`getConstraints()` Get the underlying `List` of all `Constraint` objects currently registered to this `Parameter`.
`Converter<?>`	`getConverter()` Get the `Converter` with which this `Parameter` will be converted.
`String`	`getName()` Get the name of this `Parameter`
`List<Rule>`	`getRules()` Get the list of `Rule` instances defined by this `Configuration`
`List<Transposition<String>>`	`getTranspositions()` Get the underlying `List` of all `Transposition` objects currently registered to this `Parameter`.
`Validator<?>`	`getValidator()` Get the `Validator` with which this `Parameter` will be validated.
`ConfigurationRuleParameterBuilder`	`matches(String pattern)` Configure the regular expression `Pattern` to which this `Parameter` must match.
`String`	`toString()`
`ConfigurationRuleParameterBuilder`	`transposedBy(Transposition<String> transform)` Add a `Transposition` to this `ParameterConfiguration`; it will executed in the order in which it was added.
`ConfigurationRuleParameterBuilder`	`validatedBy(Validator<?> validator)` Set the `Validator` with which this `ParameterConfiguration` value will be validated.
`ConfigurationRuleParameterBuilder`	`where(String parameter)` Configure the `Parameter` with the given name.
`ConfigurationRuleBuilderWithId`	`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`.
`ConfigurationRuleBuilderWithPriority`	`withPriority(int priority)` Set the priority of this `Rule` instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConfigurationRuleParameterBuilder
```
public ConfigurationRuleParameterBuilder(ConfigurationRuleBuilder parent,
                                         ConfigurableParameter<?> param)
```
- Method Detail
  - where
```
public ConfigurationRuleParameterBuilder where(String parameter)
```
    Description copied from interface: ConfigurationRuleParameterMatches
    
    Configure the Parameter with the given name.
    
    Specified by:
    
    where in interface ConfigurationRuleBuilderOtherwise
    
    Specified by:
    
    where in interface ConfigurationRuleParameterMatches
  - addRule
```
public ConfigurationRuleBuilderCustom addRule()
```
    Description copied from interface: ConfigurationBuilderRoot
    
    Define a new fluent Rule.
    
    Specified by:
    
    addRule in interface ConfigurationBuilderRoot
  - addRule
```
public ConfigurationRuleBuilder addRule(Rule rule)
```
    Description copied from interface: ConfigurationBuilderRoot
    
    Add a pre-defined Rule.
    
    Specified by:
    
    addRule in interface ConfigurationBuilderRoot
  - 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
  - matches
```
public ConfigurationRuleParameterBuilder matches(String pattern)
```
    Description copied from interface: ConfigurationRuleParameter
    
    Configure the regular expression Pattern to which this Parameter must match.
    
    Specified by:
    
    matches in interface ConfigurationRuleParameter
    
    Specified by:
    
    matches in interface ConfigurationRuleParameterWhere
  - configuredBy
```
public ConfigurationRuleParameterBuilder configuredBy(ParameterConfigurator configurator)
```
    Description copied from interface: ParameterConfiguration
    
    Add a ParameterConfigurator with which this ParameterConfiguration will be configured.
    
    Specified by:
    
    configuredBy in interface ConfigurationRuleParameterMatches
    
    Specified by:
    
    configuredBy in interface ParameterConfiguration<ConfigurationRuleParameterBuilder>
  - transposedBy
```
public ConfigurationRuleParameterBuilder transposedBy(Transposition<String> transform)
```
    Description copied from interface: ParameterConfiguration
    
    Add a Transposition to this ParameterConfiguration; it will executed in the order in which it was added.
    
    Specified by:
    
    transposedBy in interface ConfigurationRuleParameterMatches
    
    Specified by:
    
    transposedBy in interface ParameterConfiguration<ConfigurationRuleParameterBuilder>
  - constrainedBy
```
public ConfigurationRuleParameterBuilder constrainedBy(Constraint<String> constraint)
```
    Description copied from interface: ParameterConfiguration
    
    Add a constraint to which this ParameterConfiguration must match.
    
    Specified by:
    
    constrainedBy in interface ConfigurationRuleParameterMatches
    
    Specified by:
    
    constrainedBy in interface ParameterConfiguration<ConfigurationRuleParameterBuilder>
  - validatedBy
```
public ConfigurationRuleParameterBuilder validatedBy(Validator<?> validator)
```
    Description copied from interface: ParameterConfiguration
    
    Set the Validator with which this ParameterConfiguration value will be validated.
    
    Specified by:
    
    validatedBy in interface ConfigurationRuleParameterMatches
    
    Specified by:
    
    validatedBy in interface ParameterConfiguration<ConfigurationRuleParameterBuilder>
  - convertedBy
```
public ConfigurationRuleParameterBuilder convertedBy(Converter<?> converter)
```
    Description copied from interface: ParameterConfiguration
    
    Set the Converter with which this ParameterConfiguration value will be converted.
    
    Specified by:
    
    convertedBy in interface ConfigurationRuleParameterMatches
    
    Specified by:
    
    convertedBy in interface ParameterConfiguration<ConfigurationRuleParameterBuilder>
  - bindsTo
```
public ConfigurationRuleParameterBuilder bindsTo(Binding binding)
```
    Description copied from interface: ParameterConfiguration
    
    Add a Binding to this ParameterConfiguration.
    
    Specified by:
    
    bindsTo in interface ConfigurationRuleParameterMatches
    
    Specified by:
    
    bindsTo in interface ParameterConfiguration<ConfigurationRuleParameterBuilder>
  - withId
```
public ConfigurationRuleBuilderWithId withId(String id)
```
    Description copied from interface: ConfigurationRuleBuilderOtherwise
    
    Set the ID for the current Rule. This may be used in logging and for rule lookup purposes.
    
    Specified by:
    
    withId in interface ConfigurationRuleBuilderOtherwise
  - withPriority
```
public ConfigurationRuleBuilderWithPriority withPriority(int priority)
```
    Description copied from interface: ConfigurationRuleBuilderOtherwise
    
    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
  - 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
  - getBindings
```
public List<Binding> getBindings()
```
    Description copied from interface: Parameter
    
    Retrieve all Binding instances to which this Parameter is bound.
    
    Specified by:
    
    getBindings in interface Parameter<ConfigurationRuleParameterBuilder>
  - getName
```
public String getName()
```
    Description copied from interface: Parameter
    
    Get the name of this Parameter
    
    Specified by:
    
    getName in interface Parameter<ConfigurationRuleParameterBuilder>
  - getConverter
```
public Converter<?> getConverter()
```
    Description copied from interface: Parameter
    
    Get the Converter with which this Parameter will be converted.
    
    Specified by:
    
    getConverter in interface Parameter<ConfigurationRuleParameterBuilder>
  - getValidator
```
public Validator<?> getValidator()
```
    Description copied from interface: Parameter
    
    Get the Validator with which this Parameter will be validated.
    
    Specified by:
    
    getValidator in interface Parameter<ConfigurationRuleParameterBuilder>
  - getConstraints
```
public List<Constraint<String>> getConstraints()
```
    Description copied from interface: Parameter
    
    Get the underlying List of all Constraint objects currently registered to this Parameter.
    
    Specified by:
    
    getConstraints in interface Parameter<ConfigurationRuleParameterBuilder>
  - getTranspositions
```
public List<Transposition<String>> getTranspositions()
```
    Description copied from interface: Parameter
    
    Get the underlying List of all Transposition objects currently registered to this Parameter.
    
    Specified by:
    
    getTranspositions in interface Parameter<ConfigurationRuleParameterBuilder>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ConfigurationRuleParameterBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigurationRuleParameterBuilder

Method Detail

where

addRule

addRule

getRules

matches

configuredBy

transposedBy

constrainedBy

validatedBy

convertedBy

bindsTo

withId

withPriority

withMetadata

getBindings

getName

getConverter

getValidator

getConstraints

getTranspositions

toString