io.github.fablabsmc.fablabs.impl.fiber.constraint

Class ConstraintChecker<V,T extends SerializableType<V>>

java.lang.Object

io.github.fablabsmc.fablabs.impl.fiber.constraint.ConstraintChecker<V,T>

Type Parameters:

V - the type of values this constraint checks

Direct Known Subclasses:

BooleanConstraintChecker, DecimalConstraintChecker, EnumConstraintChecker, ListConstraintChecker, MapConstraintChecker, RecordConstraintChecker, StringConstraintChecker

public abstract class ConstraintChecker<V,T extends SerializableType<V>>
extends Object

Checks the validity of values based on a SerializableType's constraints.

See Also:

ConfigLeaf, SerializableType

Method Summary

Modifier and Type	Method and Description
abstract boolean	comprehends(T cfg, T cfg2) Returns true if cfg comprehends cfg2.
abstract TypeCheckResult<V>	test(T cfg, V value) Tests a value against this Constraint.

Methods inherited from class java.lang.Object

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

Method Detail

test

public abstract TypeCheckResult<V> test(T cfg,
                                        V value)

Tests a value against this Constraint.

This method may provide a corrected value that can be used if the input value is invalid.

Parameters:

cfg - the type configuration to test against

value - the value

Returns:

true if value satisfies the constraint

comprehends

public abstract boolean comprehends(T cfg,
                                    T cfg2)

Returns true if cfg comprehends cfg2.

A type configuration comprehends another if it accepts every value that the other does.

forall x, cfg2.accepts(x) => cfg.accepts(x)

Parameters:

cfg - the tested comprehensive type configuration

cfg2 - the tested comprehended type configuration

Returns:

true if cfg comprehends cfg2, otherwise false.

See Also:

SerializableType.isAssignableFrom(SerializableType)