com.github.valid8j.pcond.core.fluent

Interface Checker<V extends Checker<V,T,R>,T,R>

Type Parameters:

V - The type of the checker.

T - The type from which the target value is transformed.

R - The type of the target value.

All Superinterfaces:

Matcher<V,T,R>, Statement<T>

All Known Subinterfaces:

AbstractObjectChecker<V,T,R>, BooleanChecker<T>, ComparableNumberChecker<V,T,N>, DoubleChecker<T>, FloatChecker<T>, IntegerChecker<OIN>, ListChecker<T,E>, LongChecker<OIN>, ObjectChecker<OIN,E>, ShortChecker<T>, StreamChecker<T,E>, StringChecker<T>, ThrowableChecker<T,E>

All Known Implementing Classes:

BooleanChecker.Impl, Checker.Base, DoubleChecker.Impl, FloatChecker.Impl, IntegerChecker.Impl, ListChecker.Impl, LongChecker.Impl, ObjectChecker.Impl, ShortChecker.Impl, StreamChecker.Impl, StringChecker.Impl, ThrowableChecker.Impl

public interface Checker<V extends Checker<V,T,R>,T,R>
extends Matcher<V,T,R>, Statement<T>

An interface that defines methods to check a target value. By default, calls of checking methods defined in this and sub-interfaces of this interface will be a conjunction of them. To make it a disjunction, call Matcher.anyOf().

User-exposing methods to check values in this method names should be progressive and its objective so that they can follow "to be" or "satisfies" in an English sentence.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Checker.Base<V extends Checker<V,T,R>,T,R>

Nested classes/interfaces inherited from interface com.github.valid8j.pcond.core.fluent.Matcher

Matcher.JunctionType

Method Summary

Modifier and Type	Method and Description
default Statement<Object>	$() When you use an assertion method that accepts multiple statements (Statement), it requires all the elements in the array (varargs) should have the same generic parameter type.
V	addCheckPhrase(Function<Checker<?,R,R>,Predicate<R>> phrase)
default V	checkWithPredicate(Predicate<? super R> predicate) Checks if the target value satisfies the given predicate.
default Predicate<T>	done() Convert this object into a printable predicate to check the target value.
default V	not(Function<V,V> phrase)
default V	predicate(Predicate<? super R> predicate) A synonym of checkWithPredicate(Predicate).

Methods inherited from interface com.github.valid8j.pcond.core.fluent.Matcher

allOf, anyOf, toPredicate, transformFunction

Methods inherited from interface com.github.valid8j.pcond.fluent.Statement

booleanValue, createPredicateForAllOf, doubleValue, floatValue, integerValue, listValue, longValue, objectValue, shortValue, statementPredicate, statementValue, streamValue, stringValue, throwableValue

Method Detail

addCheckPhrase

V addCheckPhrase(Function<Checker<?,R,R>,Predicate<R>> phrase)

checkWithPredicate

default V checkWithPredicate(Predicate<? super R> predicate)

Checks if the target value satisfies the given predicate.

Parameters:

predicate - A predicate to check the target value.

Returns:

This object.

predicate

default V predicate(Predicate<? super R> predicate)

A synonym of checkWithPredicate(Predicate).

Parameters:

predicate - A predicate to check the target value.

Returns:

this object.

done

default Predicate<T> done()

Convert this object into a printable predicate to check the target value.

Returns:

A predicate to check the target value.

not

default V not(Function<V,V> phrase)

$

default Statement<Object> $()

When you use an assertion method that accepts multiple statements (Statement), it requires all the elements in the array (varargs) should have the same generic parameter type. However, you sometimes want to check multiple types at once. By calling this method for every statement building method calling chain, you can address the compilation error.

class Example {
  public static void main(String... args) {
    assert all(
       objectValue(arg[0]).isNotNull().$(),
       objectValue(new Example()).isNotNull().$(),
       ...
    );
  }
}

Returns:

A statement for java.lang.Object type.