Package com.tngtech.archunit.lang

Class ArchCondition.ConditionByPredicate<T extends HasDescription & HasSourceCodeLocation>

java.lang.Object

com.tngtech.archunit.lang.ArchCondition<T>

com.tngtech.archunit.lang.ArchCondition.ConditionByPredicate<T>

Type Parameters:

T - The type of object the condition will test

Enclosing class:

ArchCondition<T>

@PublicAPI(usage=ACCESS)
public static final class ArchCondition.ConditionByPredicate<T extends HasDescription & HasSourceCodeLocation>
extends ArchCondition<T>

An ArchCondition that derives which objects satisfy/violate the condition from a DescribedPredicate. The description is taken from the defining predicate but can be overridden via as(String, Object...). How the message of each single event is derived can be customized by describeEventsBy(EventDescriber).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ArchCondition.ConditionByPredicate.EventDescriber	Defines how to describe a single ConditionEvent.

Nested classes/interfaces inherited from class com.tngtech.archunit.lang.ArchCondition

ArchCondition.ConditionByPredicate<T extends HasDescription & HasSourceCodeLocation>

Method Summary

Modifier and Type	Method	Description
ArchCondition.ConditionByPredicate<T>	as(String description, Object... args)	Overwrites the description of this ArchCondition.
void	check(T object, ConditionEvents events)
ArchCondition.ConditionByPredicate<T>	describeEventsBy(ArchCondition.ConditionByPredicate.EventDescriber eventDescriber)	Adjusts how this condition will create the description of the events.
<U extends T> ArchCondition.ConditionByPredicate<U>	forSubtype()	Convenience method to downcast the condition.

Methods inherited from class com.tngtech.archunit.lang.ArchCondition

and, finish, from, getDescription, init, or, toString

Methods inherited from class java.lang.Object

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

Method Details

describeEventsBy

@PublicAPI(usage=ACCESS)
public ArchCondition.ConditionByPredicate<T> describeEventsBy(ArchCondition.ConditionByPredicate.EventDescriber eventDescriber)

Adjusts how this condition will create the description of the events. E.g. assume the predicate of this condition is simpleName(name), then this method could be used to adjust the event description as

 condition.describeEventsBy((predicateDescription, satisfied) ->
     (satisfied ? "has " : "does not have ") + predicateDescription
 )

Parameters:

eventDescriber - Specifies how to create the description of the ConditionEvent whenever the predicate is evaluated against an object.

Returns:

A ConditionByPredicate that describes its events with the given EventDescriber

as

public ArchCondition.ConditionByPredicate<T> as(String description,
 Object... args)

Description copied from class: ArchCondition

Overwrites the description of this ArchCondition. E.g.

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

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

Overrides:

as in class ArchCondition<T extends HasDescription & HasSourceCodeLocation>

Parameters:

description - The new description of this ArchCondition

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

Returns:

An ArchCondition with adjusted description.

forSubtype

public <U extends T>
ArchCondition.ConditionByPredicate<U> forSubtype()

Description copied from class: ArchCondition

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

Overrides:

forSubtype in class ArchCondition<T extends HasDescription & HasSourceCodeLocation>

Type Parameters:

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

Returns:

An ArchCondition accepting a subtype of the condition's actual type parameter T

check

public void check(T object,
 ConditionEvents events)

Specified by:

check in class ArchCondition<T extends HasDescription & HasSourceCodeLocation>