Package com.tngtech.archunit.lang

Class ArchCondition<T>

java.lang.Object

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

Direct Known Subclasses:

AllDependenciesCondition, AnyDependencyCondition, PlantUmlArchCondition

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

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)
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()
String	getDescription()
void	init(Iterable<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(Iterable<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)

toString

public String toString()

Overrides:

toString in class Object

forSubtype

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