org.ocpsoft.rewrite.param

Class ParameterBuilder<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

java.lang.Object

org.ocpsoft.rewrite.param.ParameterBuilder<IMPLTYPE>

All Implemented Interfaces:

ConfigurableParameter<IMPLTYPE>, Parameter<IMPLTYPE>, ParameterConfiguration<IMPLTYPE>

Direct Known Subclasses:

DefaultParameter

public abstract class ParameterBuilder<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>
extends Object
implements ConfigurableParameter<IMPLTYPE>

An base implementation of Parameter

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParameterBuilder(String name) Create a new ParameterBuilder instance with the given name.

Method Summary

Methods

Modifier and Type	Method and Description
IMPLTYPE	bindsTo(Binding binding) Add a Binding to this ParameterConfiguration.
IMPLTYPE	configuredBy(ParameterConfigurator configurator) Add a ParameterConfigurator with which this ParameterConfiguration will be configured.
IMPLTYPE	constrainedBy(Constraint<String> constraint) Add a constraint to which this ParameterConfiguration must match.
IMPLTYPE	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<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.
String	toString()
IMPLTYPE	transposedBy(Transposition<String> transform) Add a Transposition to this ParameterConfiguration; it will executed in the order in which it was added.
IMPLTYPE	validatedBy(Validator<?> validator) Set the Validator with which this ParameterConfiguration value will be validated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterBuilder

protected ParameterBuilder(String name)

Create a new ParameterBuilder instance with the given name.

Method Detail

configuredBy

public IMPLTYPE configuredBy(ParameterConfigurator configurator)

Description copied from interface: ParameterConfiguration

Add a ParameterConfigurator with which this ParameterConfiguration will be configured.

Specified by:

configuredBy in interface ParameterConfiguration<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

bindsTo

public IMPLTYPE bindsTo(Binding binding)

Description copied from interface: ParameterConfiguration

Add a Binding to this ParameterConfiguration.

Specified by:

bindsTo in interface ParameterConfiguration<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

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<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

getName

public String getName()

Description copied from interface: Parameter

Get the name of this Parameter

Specified by:

getName in interface Parameter<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

convertedBy

public IMPLTYPE convertedBy(Converter<?> converter)

Description copied from interface: ParameterConfiguration

Set the Converter with which this ParameterConfiguration value will be converted.

Specified by:

convertedBy in interface ParameterConfiguration<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

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<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

validatedBy

public IMPLTYPE validatedBy(Validator<?> validator)

Description copied from interface: ParameterConfiguration

Set the Validator with which this ParameterConfiguration value will be validated.

Specified by:

validatedBy in interface ParameterConfiguration<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

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<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

constrainedBy

public IMPLTYPE constrainedBy(Constraint<String> constraint)

Description copied from interface: ParameterConfiguration

Add a constraint to which this ParameterConfiguration must match.

Specified by:

constrainedBy in interface ParameterConfiguration<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

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<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

transposedBy

public IMPLTYPE 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 ParameterConfiguration<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

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<IMPLTYPE extends ParameterBuilder<IMPLTYPE>>

toString

public String toString()

Overrides:

toString in class Object