Uses of Interface
org.klojang.check.relation.Relation

Packages that use Relation

Package	Description
org.klojang.check	The central package of this Java module.
org.klojang.check.relation	A collection of functional interfaces that together constitute one category of checks that can be executed using Klojang Check.

Uses of Relation in org.klojang.check

Methods in org.klojang.check that return Relation

Modifier and Type	Method	Description
static <E, C0 extends Collection<E>, C1 extends Collection<? super E>> Relation<C0,C1>	CommonChecks.containedIn()	Verifies that a Collection argument is a subset or sublist of another Collection.
static <O, S extends Collection<? super O>> Relation<S,O>	CommonChecks.contains()	Verifies that a collection contains a particular value.
static <E, C0 extends Collection<? super E>, C1 extends Collection<E>> Relation<C0,C1>	CommonChecks.containsAll()	Verifies that a Collection argument contains all the elements of the specified collection.
static <O, S extends Map<? super O, ?>> Relation<S,O>	CommonChecks.containsKey()	Verifies that a map contains a particular key.
static Relation<String,String>	CommonChecks.containsMatch()	Verifies that the argument contains the specified pattern (that is, the pattern can be found somewhere in the string).
static Relation<String,Pattern>	CommonChecks.containsPattern()	Verifies that the argument contains the specified pattern (that is, the pattern can be found somewhere in the string).
static <O, S extends Map<?, ? super O>> Relation<S,O>	CommonChecks.containsValue()	Verifies that a map contains a particular value.
static <S, O extends Collection<? super S>> Relation<S,O>	CommonChecks.elementOf()	Alias for CommonChecks.in().
static Relation<String,String>	CommonChecks.endsWith()	Verifies that the argument ends with the specified substring.
static Relation<String,String>	CommonChecks.endsWithIC()	Verifies that a string value starts with, ignoring case, the specified string.
static <S, O> Relation<S,O>	CommonChecks.EQ()	Verifies that the argument equals the provided value.
static Relation<String,String>	CommonChecks.equalsIC()	Verifies that a string value equals, ignoring case, the specified string.
static <T> Relation<T,T>	CommonChecks.equalTo()	Verifies that the argument equals some value.
static <T extends Comparable<T>> Relation<T,T>	CommonChecks.GT()	Verifies that the argument is greater than another value.
static <T extends Comparable<T>> Relation<T,T>	CommonChecks.GTE()	Verifies that the argument is greater than or equal to another value.
static Relation<String,Pattern>	CommonChecks.hasPattern()	Verifies that the argument matches the specified pattern (that is, the pattern fully describes the string).
static Relation<String,CharSequence>	CommonChecks.hasSubstring()	Verifies that the argument contains the specified substring.
static Relation<String,String>	CommonChecks.hasSubstringIC()	Verifies that a string value contains, ignoring case, the specified string.
static <S, O extends Collection<? super S>> Relation<S,O>	CommonChecks.in()	Verifies that the argument is an element of a collection.
static <O, S extends O> Relation<S,O[]>	CommonChecks.inArray()	Verifies that the argument is an element of an array.
static <S> Relation<S,Class<?>>	CommonChecks.instanceOf()	Verifies that the argument is an instance of a particular class or interface.
static <S, O extends Map<? super S, ?>> Relation<S,O>	CommonChecks.keyIn()	Verifies the presence of a key within a map.
static <T extends Comparable<T>> Relation<T,T>	CommonChecks.LT()	Verifies that the argument is less than another value.
static <T extends Comparable<T>> Relation<T,T>	CommonChecks.LTE()	Verifies that the argument is less than or equal to another value.
static Relation<String,String>	CommonChecks.matches()	Verifies that the argument matches the specified pattern (that is, the pattern fully describes the string).
static <T> Relation<T,T>	CommonChecks.nullOr()	Verifies that the argument is either null or equals a particular value.
static <T extends Number> Relation<String,Class<T>>	CommonChecks.numerical()	Verifies that a string can be parsed into a number of the specified type without loss of information.
static <T extends Number> Relation<String,Class<T>>	CommonChecks.parsableAs()	Verifies that a string can be parsed into a Number of the specified type without loss of information.
static <S, O> Relation<S,O>	CommonChecks.sameAs()	Verifies that a value references the same object as another value.
static Relation<String,String>	CommonChecks.startsWith()	Verifies that the argument starts with the specified substring.
static Relation<String,String>	CommonChecks.startsWithIC()	Verifies that a string value starts with, ignoring case, the specified string.
static Relation<String,String>	CommonChecks.substringOf()	Verifies that the argument is a substring of the specified string.
static <S, O> Relation<Class<S>,Class<O>>	CommonChecks.subtypeOf()	Verifies that the argument is a subtype of the provided type.
static <S, O> Relation<Class<S>,Class<O>>	CommonChecks.supertypeOf()	Verifies that the argument is a supertype of the provided type.
static <S, O extends Map<?, ? super S>> Relation<S,O>	CommonChecks.valueIn()	Verifies the presence of a value within a map.

Methods in org.klojang.check with parameters of type Relation

Modifier and Type	Method	Description
<P, O> IntCheck<X>	IntCheck.has(IntFunction<P> property, String name, Relation<P,O> test, O object)	Validates a property of the argument.
<P, O> IntCheck<X>	IntCheck.has(IntFunction<P> property, Relation<P,O> test, O object)	Validates a property of the argument.
<P, O> IntCheck<X>	IntCheck.has(IntFunction<P> property, Relation<P,O> test, O object, String message, Object... msgArgs)	Validates a property of the argument.
<P, O, X2 extends Exception> IntCheck<X>	IntCheck.has(IntFunction<P> property, Relation<P,O> test, O object, Supplier<X2> exception)	Validates a property of the argument.
<P, O> ObjectCheck<T,X>	ObjectCheck.has(Function<T,P> property, String name, Relation<P,O> test, O object)	Validates a property of the argument, retrieved through the specified function, using the specified test.
<P, O> ObjectCheck<T,X>	ObjectCheck.has(Function<T,P> property, Relation<P,O> test, O object)	Validates a property of the argument, retrieved through the specified function, using the specified test.
<P, O> ObjectCheck<T,X>	ObjectCheck.has(Function<T,P> property, Relation<P,O> test, O object, String message, Object... msgArgs)	Validates a property of the argument using the specified test.
<P, O, X2 extends Exception> ObjectCheck<T,X>	ObjectCheck.has(Function<T,P> property, Relation<P,O> test, O object, Supplier<X2> exception)	Validates a property of the argument, retrieved through the specified function, using the specified test.
<O> ObjectCheck<T,X>	ObjectCheck.is(Relation<T,O> test, O object)	Validates the argument using the specified test.
<O> ObjectCheck<T,X>	ObjectCheck.is(Relation<T,O> test, O object, String message, Object... msgArgs)	Validates the argument using the specified test.
<O, X2 extends Exception> ObjectCheck<T,X>	ObjectCheck.is(Relation<T,O> test, O object, Supplier<X2> exception)	Validates the argument using the specified test.
<O> ObjectCheck<T,X>	ObjectCheck.isNot(Relation<T,O> test, O object)	Validates the argument using the specified test.
<O> ObjectCheck<T,X>	ObjectCheck.isNot(Relation<T,O> test, O object, String message, Object... msgArgs)	Validates the argument using the specified test.
<O, X2 extends Exception> ObjectCheck<T,X>	ObjectCheck.isNot(Relation<T,O> test, O object, Supplier<X2> exception)	Validates the argument using the specified test.
<P, O> IntCheck<X>	IntCheck.notHas(IntFunction<P> property, String name, Relation<P,O> test, O object)	Validates a property of the argument.
<P, O> IntCheck<X>	IntCheck.notHas(IntFunction<P> property, Relation<P,O> test, O object)	Validates a property of the argument.
<P, O> IntCheck<X>	IntCheck.notHas(IntFunction<P> property, Relation<P,O> test, O object, String message, Object... msgArgs)	Validates a property of the argument.
<P, O, X2 extends Exception> IntCheck<X>	IntCheck.notHas(IntFunction<P> property, Relation<P,O> test, O object, Supplier<X2> exception)	Validates a property of the argument.
<P, O> ObjectCheck<T,X>	ObjectCheck.notHas(Function<T,P> property, String name, Relation<P,O> test, O object)	Validates a property of the argument, retrieved through the specified function, using the specified test.
<P, O> ObjectCheck<T,X>	ObjectCheck.notHas(Function<T,P> property, Relation<P,O> test, O object)	Validates a property of the argument, retrieved through the specified function, using the specified test.
<P, O> ObjectCheck<T,X>	ObjectCheck.notHas(Function<T,P> property, Relation<P,O> test, O object, String message, Object... msgArgs)	Validates a property of the argument using the specified test.
<P, O, X2 extends Exception> ObjectCheck<T,X>	ObjectCheck.notHas(Function<T,P> property, Relation<P,O> test, O object, Supplier<X2> exception)	Validates a property of the argument, retrieved through the specified function, using the specified test.

Uses of Relation in org.klojang.check.relation

Methods in org.klojang.check.relation that return Relation

Modifier and Type	Method	Description
default Relation<O,S>	Relation.converse()	Returns the converse of this relation, swapping subject and object in the relationship.
default Relation<S,O>	Relation.negate()	Returns the negation of this Relation.

Methods in org.klojang.check.relation with parameters of type Relation

Modifier and Type	Method	Description
default <S, O, P extends O> ComposableIntPredicate	ComposableIntPredicate.and(S subject, Relation<S,O> relation, Quantifier quantifier, P... objects)	Returns a new test combining this test and the specified test.
default <O, P extends O, V> ComposablePredicate<V>	ComposablePredicate.and(Relation<V,O> relation, Quantifier quantifier, P... objects)	Returns a new test combining this test and the specified test.
default <S, O, P extends O, V> ComposablePredicate<V>	ComposablePredicate.and(S subject, Relation<S,O> relation, Quantifier quantifier, P... objects)	Returns a new test combining this test and the specified test.
default <O, V> ComposablePredicate<V>	ComposablePredicate.andAlso(Relation<?,O> relation, O object)	Returns a new test combining this test and the specified test.
default <S, O> ComposableIntPredicate	ComposableIntPredicate.andNot(S subject, Relation<S,O> relation, O object)	Returns a new test combining this test and the specified test.
default <O, V> ComposablePredicate<V>	ComposablePredicate.andNot(Relation<?,O> relation, O object)	Returns a new test combining this test and the specified test.
default <S, O, V> ComposablePredicate<V>	ComposablePredicate.andNot(S subject, Relation<S,O> relation, O object)	Returns a new test combining this test and the specified test.
default <S, O> ComposableIntPredicate	ComposableIntPredicate.andThat(S subject, Relation<S,O> relation, O object)	Returns a new test combining this test and the specified test.
default <S, O, V> ComposablePredicate<V>	ComposablePredicate.andThat(S subject, Relation<S,O> relation, O object)	Returns a new test combining this test and the specified test.
default <S, O, P extends O> ComposableIntPredicate	ComposableIntPredicate.or(S subject, Relation<S,O> relation, Quantifier quantifier, P... objects)	Returns a new test combining this test and the specified test.
default <O, P extends O, V> ComposablePredicate<V>	ComposablePredicate.or(Relation<V,O> relation, Quantifier quantifier, P... objects)	Returns a new test combining this test and the specified test.
default <S, O, P extends O, V> ComposablePredicate<V>	ComposablePredicate.or(S subject, Relation<S,O> relation, Quantifier quantifier, P... objects)	Returns a new test combining this test and the specified test.
default <O, V> ComposablePredicate<V>	ComposablePredicate.orElse(Relation<?,O> relation, O object)	Returns a new test combining this test and the specified test.
default <S, O> ComposableIntPredicate	ComposableIntPredicate.orNot(S subject, Relation<S,O> relation, O object)	Returns a new test combining this test and the specified test.
default <O, V> ComposablePredicate<V>	ComposablePredicate.orNot(Relation<?,O> relation, O object)	Returns a new test combining this test and the specified test.
default <S, O, V> ComposablePredicate<V>	ComposablePredicate.orNot(S subject, Relation<S,O> relation, O object)	Returns a new test combining this test and the specified test.
default <S, O> ComposableIntPredicate	ComposableIntPredicate.orThat(S subject, Relation<S,O> relation, O object)	Returns a new test combining this test and the specified test.
default <S, O, V> ComposablePredicate<V>	ComposablePredicate.orThat(S subject, Relation<S,O> relation, O object)	Returns a new test combining this test and the specified test.
static <S, O> ComposablePredicate<S>	Compose.validWhen(Relation<S,O> relation, O object)	Converts a Relation to a ComposablePredicate.