me.zeroeightsix.fiber.builder.constraint

Class ConstraintsBuilder<S,T>

java.lang.Object

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

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

Type Parameters:

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

T - the type of Constraint this builder should output

Direct Known Subclasses:

AggregateConstraintsBuilder

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

A builder for Constraints.

The constraints created by this builder consider constrained values as atomic, and do not allow the specification of component-level constraints. Settings with aggregate types, such as arrays and collections, should be created using AggregateConstraintsBuilder.

See Also:

AggregateConstraintsBuilder

Field Summary

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

source, sourceConstraints, type

Constructor Summary

Constructors

Constructor and Description
ConstraintsBuilder(S source, java.util.List<Constraint<? super T>> constraints, java.lang.Class<T> type) Creates a new scalar constraint builder

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstraintsBuilder

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

Creates a new scalar constraint builder

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

Method Detail

atLeast

public ConstraintsBuilder<S,T> atLeast(T min)
                                throws RuntimeFiberException

Description copied from class: AbstractConstraintsBuilder

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

Overrides:

atLeast in class AbstractConstraintsBuilder<S,T,T>

Parameters:

min - The minimum value

Returns:

The builder

Throws:

RuntimeFiberException

atMost

public ConstraintsBuilder<S,T> atMost(T max)

Description copied from class: AbstractConstraintsBuilder

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

Overrides:

atMost in class AbstractConstraintsBuilder<S,T,T>

Parameters:

max - The maximum value

Returns:

The builder

range

public ConstraintsBuilder<S,T> range(T min,
                                     T 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 AbstractConstraintsBuilder<S,T,T>

Parameters:

min - The minimum value

max - The maximum value

Returns:

This builder

minLength

public ConstraintsBuilder<S,T> minLength(int min)

Overrides:

minLength in class AbstractConstraintsBuilder<S,T,T>

maxLength

public ConstraintsBuilder<S,T> maxLength(int max)

Overrides:

maxLength in class AbstractConstraintsBuilder<S,T,T>

regex

public ConstraintsBuilder<S,T> regex(java.lang.String regexPattern)

Overrides:

regex in class AbstractConstraintsBuilder<S,T,T>

composite

public CompositeConstraintsBuilder<? extends ConstraintsBuilder<S,T>,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