me.zeroeightsix.fiber.api.builder.constraint

Class AggregateConstraintsBuilder<A,E>

java.lang.Object

me.zeroeightsix.fiber.api.builder.constraint.AbstractConstraintsBuilder<ConfigLeafBuilder<T>,T,T>

me.zeroeightsix.fiber.api.builder.constraint.ConstraintsBuilder<A>

me.zeroeightsix.fiber.api.builder.constraint.AggregateConstraintsBuilder<A,E>

Type Parameters:

A - the type of Constraint this builder should output

E - the type of the components in T

public class AggregateConstraintsBuilder<A,E>
extends ConstraintsBuilder<A>

An implementation of ConstraintsBuilder for aggregate constraints.

Aggregate types are those that hold multiple values, such as List or arrays. The other, scalar types, such as Integer or String, are created using ConstraintsBuilder.

See Also:

ConstraintsBuilder

Field Summary

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

source, sourceConstraints, type

Constructor Summary

Constructors

Constructor and Description
AggregateConstraintsBuilder(ConfigAggregateBuilder<A,E> source, java.util.List<Constraint<? super A>> constraints, java.lang.Class<A> aggregateType, java.lang.Class<E> componentType) Creates a new aggregate constraint builder

Method Summary

Modifier and Type	Method and Description
AggregateConstraintsBuilder<A,E>	atLeast(A min) Implies that any value must be bigger than or equal to min
AggregateConstraintsBuilder<A,E>	atMost(A max) Implies that any value must be smaller than or equal to max
ComponentConstraintsBuilder<AggregateConstraintsBuilder<A,E>,A,E>	component() Creates a new ComponentConstraintsBuilder.
CompositeConstraintsBuilder<AggregateConstraintsBuilder<A,E>,A>	composite(CompositeType type) Creates a new CompositeConstraintBuilder from this ConstraintsBuilder.
ConfigAggregateBuilder<A,E>	finishConstraints() Finishes building constraints.
AggregateConstraintsBuilder<A,E>	maxLength(int max)
AggregateConstraintsBuilder<A,E>	minLength(int min)
AggregateConstraintsBuilder<A,E>	range(A min, A max) Convenience method to specify a range of valid values a number can take.
AggregateConstraintsBuilder<A,E>	regex(java.lang.String regexPattern)

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

getType

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregateConstraintsBuilder

public AggregateConstraintsBuilder(ConfigAggregateBuilder<A,E> source,
                                   java.util.List<Constraint<? super A>> constraints,
                                   @Nonnull
                                   java.lang.Class<A> aggregateType,
                                   @Nullable
                                   java.lang.Class<E> componentType)

Creates a new aggregate constraint builder

Parameters:

source - the ConfigLeafBuilder 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

Method Detail

atLeast

public AggregateConstraintsBuilder<A,E> atLeast(A min)
                                         throws RuntimeFiberException

Description copied from class: AbstractConstraintsBuilder

Implies that any value must be bigger than or equal to min

Overrides:

atLeast in class ConstraintsBuilder<A>

Parameters:

min - The minimum value

Returns:

The builder

Throws:

RuntimeFiberException

atMost

public AggregateConstraintsBuilder<A,E> atMost(A max)

Description copied from class: AbstractConstraintsBuilder

Implies that any value must be smaller than or equal to max

Overrides:

atMost in class ConstraintsBuilder<A>

Parameters:

max - The maximum value

Returns:

The builder

range

public AggregateConstraintsBuilder<A,E> range(A min,
                                              A max)

Description copied from class: AbstractConstraintsBuilder

Convenience method to specify a range of valid values a number can take.

This method behaves as if: this.atLeast(min).atMost(max)

Overrides:

range in class ConstraintsBuilder<A>

Parameters:

min - The minimum value

max - The maximum value

Returns:

This builder

minLength

public AggregateConstraintsBuilder<A,E> minLength(int min)

Overrides:

minLength in class ConstraintsBuilder<A>

maxLength

public AggregateConstraintsBuilder<A,E> maxLength(int max)

Overrides:

maxLength in class ConstraintsBuilder<A>

regex

public AggregateConstraintsBuilder<A,E> regex(java.lang.String regexPattern)

Overrides:

regex in class ConstraintsBuilder<A>

composite

public CompositeConstraintsBuilder<AggregateConstraintsBuilder<A,E>,A> composite(CompositeType type)

Description copied from class: ConstraintsBuilder

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.

Overrides:

composite in class ConstraintsBuilder<A>

Parameters:

type - the type of composite to create

Returns:

the newly created builder

component

public ComponentConstraintsBuilder<AggregateConstraintsBuilder<A,E>,A,E> component()

Creates a new ComponentConstraintsBuilder.

Component constraints are constraints that test each value in an aggregate type. By default, all tested elements must satisfy the constraint in order for the entire constraint to be satisfied.

Returns:

the newly created builder

finishConstraints

public ConfigAggregateBuilder<A,E> finishConstraints()

Description copied from class: ConstraintsBuilder

Finishes building constraints.

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

Overrides:

finishConstraints in class ConstraintsBuilder<A>

Returns:

the source builder