Package com.tngtech.archunit.base

Class DescribedPredicate<T>

java.lang.Object

com.tngtech.archunit.base.DescribedPredicate<T>

Type Parameters:

T - The type of objects the predicate applies to

All Implemented Interfaces:

Predicate<T>

Direct Known Subclasses:

PackageMatchers

@PublicAPI(usage=INHERITANCE)
public abstract class DescribedPredicate<T>
extends Object
implements Predicate<T>

A predicate holding a description.

Constructor Summary

Constructors

Constructor	Description
DescribedPredicate(String description, Object... params)

Method Summary

Modifier and Type	Method	Description
static <T> DescribedPredicate<Iterable<T>>	allElements(DescribedPredicate<? super T> predicate)
static <T> DescribedPredicate<T>	alwaysFalse()
static <T> DescribedPredicate<T>	alwaysTrue()
DescribedPredicate<T>	and(DescribedPredicate<? super T> other)
static <T> DescribedPredicate<T>	and(DescribedPredicate<? super T>... predicates)
static <T> DescribedPredicate<T>	and(Iterable<? extends DescribedPredicate<? super T>> predicates)
static <T> DescribedPredicate<Iterable<? extends T>>	anyElementThat(DescribedPredicate<? super T> predicate)
DescribedPredicate<T>	as(String description, Object... params)	Overwrites the description of this DescribedPredicate.
static <T> DescribedPredicate<T>	describe(String description, Predicate<? super T> predicate)
static <T> DescribedPredicate<T>	doesNot(DescribedPredicate<? super T> predicate)	Same as not(DescribedPredicate) but with a different description
static <T> DescribedPredicate<T>	doNot(DescribedPredicate<? super T> predicate)	Same as not(DescribedPredicate) but with a different description
static DescribedPredicate<Iterable<?>>	empty()
static <T> DescribedPredicate<T>	equalTo(T object)
final <U extends T> DescribedPredicate<U>	forSubtype()	Convenience method to downcast the predicate.
String	getDescription()
static <T extends Comparable<T>> DescribedPredicate<T>	greaterThan(T value)
static <T extends Comparable<T>> DescribedPredicate<T>	greaterThanOrEqualTo(T value)
static <T extends Comparable<T>> DescribedPredicate<T>	lessThan(T value)
static <T extends Comparable<T>> DescribedPredicate<T>	lessThanOrEqualTo(T value)
static <T> DescribedPredicate<T>	not(DescribedPredicate<? super T> predicate)
<F> DescribedPredicate<F>	onResultOf(Function<? super F,? extends T> function)
static <T> DescribedPredicate<Optional<T>>	optionalContains(DescribedPredicate<? super T> predicate)
static <T> DescribedPredicate<Optional<T>>	optionalEmpty()
DescribedPredicate<T>	or(DescribedPredicate<? super T> other)
static <T> DescribedPredicate<T>	or(DescribedPredicate<? super T>... predicates)
static <T> DescribedPredicate<T>	or(Iterable<? extends DescribedPredicate<? super T>> predicates)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, negate, or, test

Constructor Details

DescribedPredicate

public DescribedPredicate(String description,
 Object... params)

Method Details

getDescription

public String getDescription()

as

public DescribedPredicate<T> as(String description,
 Object... params)

Overwrites the description of this DescribedPredicate. E.g.

 classes().that(predicate.as("some customized description with '%s'", "parameter")).should().bePublic()
 

would then yield classes that some customized description with 'parameter' should be public.

Parameters:

description - The new description of this DescribedPredicate

params - Optional arguments to fill into the description via String.format(String, Object...)

Returns:

An DescribedPredicate with adjusted description.

and

public DescribedPredicate<T> and(DescribedPredicate<? super T> other)

or

public DescribedPredicate<T> or(DescribedPredicate<? super T> other)

onResultOf

public <F> DescribedPredicate<F> onResultOf(Function<? super F,? extends T> function)

forSubtype

public final <U extends T> DescribedPredicate<U> forSubtype()

Convenience method to downcast the predicate. DescribedPredicates are contravariant by nature, i.e. an DescribedPredicate<T> is an instance of DescribedPredicate<V>, if and only if V is an instance of T.
Take for example Object > String. Obviously a DescribedPredicate<Object> is also a DescribedPredicate<String>.
Unfortunately, the Java type system does not allow us to express this property of the type parameter of DescribedPredicate. So to avoid forcing users to cast everywhere it is possible to use this method which also documents the intention and reasoning.

Type Parameters:

U - A subtype of the DescribedPredicate's type parameter T

Returns:

A DescribedPredicate accepting a subtype of the predicate's actual type parameter T

toString

public String toString()

Overrides:

toString in class Object

alwaysTrue

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<T> alwaysTrue()

alwaysFalse

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<T> alwaysFalse()

equalTo

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<T> equalTo(T object)

lessThan

@PublicAPI(usage=ACCESS)
public static <T extends Comparable<T>>
DescribedPredicate<T> lessThan(T value)

greaterThan

@PublicAPI(usage=ACCESS)
public static <T extends Comparable<T>>
DescribedPredicate<T> greaterThan(T value)

lessThanOrEqualTo

@PublicAPI(usage=ACCESS)
public static <T extends Comparable<T>>
DescribedPredicate<T> lessThanOrEqualTo(T value)

greaterThanOrEqualTo

@PublicAPI(usage=ACCESS)
public static <T extends Comparable<T>>
DescribedPredicate<T> greaterThanOrEqualTo(T value)

describe

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<T> describe(String description,
 Predicate<? super T> predicate)

doesNot

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<T> doesNot(DescribedPredicate<? super T> predicate)

Same as not(DescribedPredicate) but with a different description

doNot

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<T> doNot(DescribedPredicate<? super T> predicate)

Same as not(DescribedPredicate) but with a different description

not

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<T> not(DescribedPredicate<? super T> predicate)

Type Parameters:

T - The type of object the predicate applies to

Parameters:

predicate - Any DescribedPredicate

Returns:

A predicate that will return true whenever the original predicate would return false and vice versa.

and

@SafeVarargs
@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<T> and(DescribedPredicate<? super T>... predicates)

See Also:

• and(Iterable)

and

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<T> and(Iterable<? extends DescribedPredicate<? super T>> predicates)

Type Parameters:

T - The type of object the predicate applies to

Parameters:

predicates - Any number of predicates to join together via *AND*

Returns:

A predicate that returns true, if all the supplied predicates return true. Otherwise, it returns false. If an empty Iterable is passed to this method the resulting predicate will always return false.

or

@SafeVarargs
@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<T> or(DescribedPredicate<? super T>... predicates)

See Also:

• or(Iterable)

or

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<T> or(Iterable<? extends DescribedPredicate<? super T>> predicates)

Type Parameters:

T - The type of object the predicate applies to

Parameters:

predicates - Any number of predicates to join together via *OR*

Returns:

A predicate that returns true, if any of the supplied predicates returns true. Otherwise, it returns false. If an empty Iterable is passed to this method the resulting predicate will always return false.

empty

@PublicAPI(usage=ACCESS)
public static DescribedPredicate<Iterable<?>> empty()

optionalContains

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<Optional<T>> optionalContains(DescribedPredicate<? super T> predicate)

optionalEmpty

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<Optional<T>> optionalEmpty()

anyElementThat

@PublicAPI(usage=ACCESS)
public static <T>
DescribedPredicate<Iterable<? extends T>> anyElementThat(DescribedPredicate<? super T> predicate)

Type Parameters:

T - The type of object the predicate applies to

Parameters:

predicate - A DescribedPredicate for the elements of the Iterable

Returns:

A predicate for an Iterable that returns true if and only if at least one element of the Iterable matches the given element predicate.

allElements

@PublicAPI(usage=ACCESS)
public static <T> DescribedPredicate<Iterable<T>> allElements(DescribedPredicate<? super T> predicate)

Type Parameters:

T - The type of object the predicate applies to

Parameters:

predicate - A DescribedPredicate for the elements of the Iterable

Returns:

A predicate for an Iterable that returns true if and only if all elements of the Iterable matche the given element predicate.