io.github.fablabsmc.fablabs.api.fiber.v1.schema.type

Class TypeCheckResult<V>

java.lang.Object

io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.TypeCheckResult<V>

Type Parameters:

V - the actual type of the tested value

public final class TypeCheckResult<V>
extends Object

The result of type checking a serialized value.

See Also:

SerializableType.test(Object)

Method Summary

Modifier and Type	Method and Description
static <V> TypeCheckResult<V>	failed(V correctedValue) Creates a failed TypeCheckResult with the given value.
Optional<V>	getCorrectedValue() Returns a possible corrected value based on the tested value.
boolean	hasPassed() Returns true if the tested value passed the type check.
static <V> TypeCheckResult<V>	successful(V initialValue) Creates a successful TypeCheckResult with the given value.
static <V> TypeCheckResult<V>	unrecoverable() Creates a failed TypeCheckResult with no value.

Methods inherited from class java.lang.Object

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

Method Detail

successful

public static <V> TypeCheckResult<V> successful(V initialValue)

Creates a successful TypeCheckResult with the given value.

failed

public static <V> TypeCheckResult<V> failed(V correctedValue)

Creates a failed TypeCheckResult with the given value.

unrecoverable

public static <V> TypeCheckResult<V> unrecoverable()

Creates a failed TypeCheckResult with no value.

hasPassed

public boolean hasPassed()

Returns true if the tested value passed the type check.

A value passes if it matches every attribute set on the SerializableType. If at least one constraint check failed, this method returns false.

Returns:

true if the test passed, false otherwise.

getCorrectedValue

public Optional<V> getCorrectedValue()

Returns a possible corrected value based on the tested value.

If the test passes, this method returns an Optional describing the tested value.

Returns:

an Optional describing a possible corrected value, or an empty Optional if the test was unrecoverable.