Package com.tngtech.archunit.lang

Class ArchCondition<T>

java.lang.Object

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

Direct Known Subclasses:

AllDependenciesCondition, AnyDependencyCondition, ArchCondition.ConditionByPredicate, CycleArchCondition, PlantUmlArchCondition, TransitiveDependencyCondition

@PublicAPI(usage=INHERITANCE)
public abstract class ArchCondition<T>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ArchCondition.ConditionByPredicate<T extends HasDescription & HasSourceCodeLocation>	An ArchCondition that derives which objects satisfy/violate the condition from a DescribedPredicate.

Constructor Summary

Constructors

Constructor	Description
ArchCondition(String description, Object... args)

Method Summary

Modifier and Type	Method	Description
ArchCondition<T>	and(ArchCondition<? super T> condition)
ArchCondition<T>	as(String description, Object... args)	Overwrites the description of this ArchCondition.
abstract void	check(T item, ConditionEvents events)
void	finish(ConditionEvents events)	Can be used/overridden to finish the evaluation of this condition. ArchUnit will call this method once after every single item was checked (by check(Object, ConditionEvents)). This method can be used, if violations are dependent on multiple/all check(Object, ConditionEvents) calls, on the contrary to the default case, where each single check(Object, ConditionEvents) stands for itself.
<U extends T> ArchCondition<U>	forSubtype()	Convenience method to downcast the condition.
static <T extends HasDescription & HasSourceCodeLocation> ArchCondition.ConditionByPredicate<T>	from(DescribedPredicate<? super T> predicate)	Creates an ArchCondition from a DescribedPredicate.
String	getDescription()
void	init(Collection<T> allObjectsToTest)	Can be used/overridden to prepare this condition with respect to the collection of all objects the condition will be tested against. ArchUnit will call this method once in the beginning, before starting to check single items.
ArchCondition<T>	or(ArchCondition<? super T> condition)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ArchCondition

public ArchCondition(String description,
 Object... args)

Method Details

init

public void init(Collection<T> allObjectsToTest)

Can be used/overridden to prepare this condition with respect to the collection of all objects the condition will be tested against.
ArchUnit will call this method once in the beginning, before starting to check single items.

Parameters:

allObjectsToTest - All objects that check(Object, ConditionEvents) will be called against

check

public abstract void check(T item,
 ConditionEvents events)

finish

public void finish(ConditionEvents events)

Can be used/overridden to finish the evaluation of this condition.
ArchUnit will call this method once after every single item was checked (by check(Object, ConditionEvents)).
This method can be used, if violations are dependent on multiple/all check(Object, ConditionEvents) calls, on the contrary to the default case, where each single check(Object, ConditionEvents) stands for itself.

and

public ArchCondition<T> and(ArchCondition<? super T> condition)

or

public ArchCondition<T> or(ArchCondition<? super T> condition)

getDescription

public String getDescription()

as

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

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'.

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.

toString

public String toString()

Overrides:

toString in class Object

forSubtype

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

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.

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

from

@PublicAPI(usage=ACCESS)
public static <T extends HasDescription & HasSourceCodeLocation>
ArchCondition.ConditionByPredicate<T> from(DescribedPredicate<? super T> predicate)

Creates an ArchCondition from a DescribedPredicate. For more information see ConditionByPredicate. For more convenient versions of this method compare ArchConditions.have(DescribedPredicate) and ArchConditions.be(DescribedPredicate).

Type Parameters:

T - The type of object the condition will check

Parameters:

predicate - Specifies which objects satisfy the condition.

Returns:

A ConditionByPredicate derived from the supplied predicate

See Also:

• ArchConditions.have(DescribedPredicate)
• ArchConditions.be(DescribedPredicate)