me.zeroeightsix.fiber.api.builder.constraint

Class AbstractConstraintsBuilder<S,A,T>

java.lang.Object

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

Type Parameters:

A - the type of Constraint this builder should output

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

T - the type of intermediary objects this builder's constraints should process. May be identical to A.

Direct Known Subclasses:

ComponentConstraintsBuilder, CompositeConstraintsBuilder, ConstraintsBuilder

public abstract class AbstractConstraintsBuilder<S,A,T>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected S	source
protected java.util.List<Constraint<? super A>>	sourceConstraints
protected java.lang.Class<T>	type

Method Summary

Modifier and Type	Method and Description
AbstractConstraintsBuilder<S,A,T>	atLeast(T min) Implies that any value must be bigger than or equal to min
AbstractConstraintsBuilder<S,A,T>	atMost(T max) Implies that any value must be smaller than or equal to max
java.lang.Class<T>	getType()
AbstractConstraintsBuilder<S,A,T>	maxLength(int max)
AbstractConstraintsBuilder<S,A,T>	minLength(int min)
AbstractConstraintsBuilder<S,A,T>	range(T min, T max) Convenience method to specify a range of valid values a number can take.
AbstractConstraintsBuilder<S,A,T>	regex(java.lang.String regexPattern)

Methods inherited from class java.lang.Object

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

Field Detail

source

protected final S source

sourceConstraints

protected final java.util.List<Constraint<? super A>> sourceConstraints

type

@Nullable
protected final java.lang.Class<T> type

Method Detail

getType

@Nullable
public final java.lang.Class<T> getType()

atLeast

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

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

Parameters:

min - The minimum value

Returns:

The builder

Throws:

java.lang.IllegalArgumentException - if min is not a Number

RuntimeFiberException

atMost

public AbstractConstraintsBuilder<S,A,T> atMost(T max)

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

Parameters:

max - The maximum value

Returns:

The builder

Throws:

java.lang.UnsupportedOperationException - if this builder is not for a numerical value

java.lang.IllegalArgumentException - if max is not a Number

range

public AbstractConstraintsBuilder<S,A,T> range(T min,
                                               T max)

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

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

Parameters:

min - The minimum value

max - The maximum value

Returns:

This builder

Throws:

java.lang.UnsupportedOperationException - if this builder is not for a numerical value

java.lang.IllegalArgumentException - if min or max is not a Number

minLength

public AbstractConstraintsBuilder<S,A,T> minLength(int min)

maxLength

public AbstractConstraintsBuilder<S,A,T> maxLength(int max)

regex

public AbstractConstraintsBuilder<S,A,T> regex(@RegEx
                                               java.lang.String regexPattern)