de.bioforscher.singa.core.utility

Interface Bounded<Type extends Comparable<Type>>

Type Parameters:

Type - The Type of the bound. Has to be Comparable.

All Known Subinterfaces:

Parameter<Type>

All Known Implementing Classes:

BooleanParameter, DoubleParameter, IntegerParameter, Range

public interface Bounded<Type extends Comparable<Type>>

Defines a Object to be bounded by a lower and upper bound. The upper and the lower bound should be specified upon Object creation. Afterwards it is possible to check whether an Object of the given Type is in between both bounds.

Author:

cl

Method Summary

Modifier and Type	Method and Description
default void	assertIfValueInRange(Type value) Asserts whether the given value is larger than the lower bound and smaller than the upper bound specified for this object.
Type	getLowerBound() Returns the lower bound specified for this object.
Type	getUpperBound() Returns the upper bound specified for this object.
default boolean	isInRange(Type value) Checks whether the given value is larger than the lower bound and smaller than the upper bound specified for this object.

Method Detail

getLowerBound

Type getLowerBound()

Returns the lower bound specified for this object.

Returns:

The lower bound specified for this object.

getUpperBound

Type getUpperBound()

Returns the upper bound specified for this object.

Returns:

The upper bound specified for this object.

isInRange

default boolean isInRange(Type value)

Checks whether the given value is larger than the lower bound and smaller than the upper bound specified for this object.

Parameters:

value - The value to be checked.

Returns:

true if the constraints are met.

assertIfValueInRange

default void assertIfValueInRange(Type value)

Asserts whether the given value is larger than the lower bound and smaller than the upper bound specified for this object. If not a IllegalArgumentException will be thrown.

Parameters:

value - The value to be asserted.

Throws:

IllegalArgumentException - if the constraints are not met.