me.zeroeightsix.fiber.builder.constraint

Class ConstraintsBuilder<S,T,B extends ConstraintsBuilder<S,T,B>>

java.lang.Object

me.zeroeightsix.fiber.builder.constraint.AbstractConstraintsBuilder<S,T,T,B>

me.zeroeightsix.fiber.builder.constraint.ConstraintsBuilder<S,T,B>

Type Parameters:

S - the type of this builder's source object (eg. ConfigValueBuilder or ConstraintsBuilder

T - the type of Constraint this builder should output

B - the type of this, for chaining

Direct Known Subclasses:

ConstraintsBuilder.Aggregate, ConstraintsBuilder.Scalar

public abstract class ConstraintsBuilder<S,T,B extends ConstraintsBuilder<S,T,B>>
extends AbstractConstraintsBuilder<S,T,T,B>

A builder for Constraints.

This is the abstract base class for all builders of this type. Builders implementing this class include ConstraintsBuilder.Scalar and ConstraintsBuilder.Aggregate.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConstraintsBuilder.Aggregate<S,T,C> An implementation of ConstraintsBuilder for aggregate constraints.
static class	ConstraintsBuilder.Scalar<S,T> An implementation of ConstraintsBuilder for scalar constraints.

Field Summary

Fields inherited from class me.zeroeightsix.fiber.builder.constraint.AbstractConstraintsBuilder

source, sourceConstraints, type

Method Summary

Modifier and Type	Method and Description
static <S,A,T> ConstraintsBuilder.Aggregate<S,A,T>	aggregate(S source, java.util.List<Constraint<? super A>> constraints, java.lang.Class<A> aggregateType, java.lang.Class<T> componentType) Creates a new aggregate constraint builder
CompositeConstraintBuilder<B,T>	composite(CompositeType type) Creates a new CompositeConstraintBuilder from this ConstraintsBuilder.
S	finish() Finishes building constraints.
static <S,T> ConstraintsBuilder.Scalar<S,T>	scalar(S source, java.util.List<Constraint<? super T>> constraints, java.lang.Class<T> type) Creates a new scalar constraint builder

Methods inherited from class me.zeroeightsix.fiber.builder.constraint.AbstractConstraintsBuilder

atLeast, atMost, maxLength, minLength, range, regex, self

Methods inherited from class java.lang.Object

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

Method Detail

scalar

public static <S,T> ConstraintsBuilder.Scalar<S,T> scalar(S source,
                                                          java.util.List<Constraint<? super T>> constraints,
                                                          java.lang.Class<T> type)

Creates a new scalar constraint builder

Type Parameters:

S - the type of source

T - the type type represents

Parameters:

source - the ConfigValueBuilder this ConstraintsBuilder originates from

constraints - the list of constraints this builder will add to

type - the class of the type of values checked by constraints built by this builder

Returns:

the newly created builder

See Also:

ConstraintsBuilder.Scalar

aggregate

public static <S,A,T> ConstraintsBuilder.Aggregate<S,A,T> aggregate(S source,
                                                                    java.util.List<Constraint<? super A>> constraints,
                                                                    java.lang.Class<A> aggregateType,
                                                                    java.lang.Class<T> componentType)

Creates a new aggregate constraint builder

Type Parameters:

S - the type of source

A - the type of aggregateType

T - the type of componentType

Parameters:

source - the ConfigValueBuilder this ConstraintsBuilder originates from

constraints - the list of constraints this builder will add to

aggregateType - the type of collection or array source holds

componentType - the type of all elements in aggregateType

Returns:

the newly created builder

See Also:

ConstraintsBuilder.Aggregate

composite

public CompositeConstraintBuilder<B,T> composite(CompositeType type)

Creates a new CompositeConstraintBuilder from this ConstraintsBuilder.

Composite constraints are constraints that have 0 or more child constraints.

Whether or not a value satisfies a composite constraint is specified by the composite's CompositeType.

Parameters:

type - the type of composite to create

Returns:

the newly created builder

finish

public S finish()

Finishes building constraints.

As a result of this call, the built constraints will be added to the source ConfigValue builder.

Returns:

the source builder