Package com.tngtech.archunit.library.cycle_detection.rules

Class CycleArchCondition<COMPONENT>

java.lang.Object

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

com.tngtech.archunit.library.cycle_detection.rules.CycleArchCondition<COMPONENT>

Type Parameters:

COMPONENT - The type of the component to check dependencies between

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public final class CycleArchCondition<COMPONENT>
extends ArchCondition<COMPONENT>

A generic ArchCondition to check arbitrary COMPONENTs consisting of JavaClasses for cyclic dependencies between those components (induced by the dependencies of the contained classes).
Construct it by following the fluent interface of builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CycleArchCondition.Builder<COMPONENT>
static interface	CycleArchCondition.NeedsRetrieveClasses<COMPONENT>
static interface	CycleArchCondition.NeedsRetrieveDescription<COMPONENT>
static interface	CycleArchCondition.NeedsRetrieveOutgoingDependencies<COMPONENT>

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

ArchCondition.ConditionByPredicate<T extends HasDescription & HasSourceCodeLocation>

Method Summary

Modifier and Type	Method	Description
static <COMPONENT> CycleArchCondition.NeedsRetrieveClasses<COMPONENT>	builder()
void	check(COMPONENT component, 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 ArchCondition.check(Object, ConditionEvents)). This method can be used, if violations are dependent on multiple/all ArchCondition.check(Object, ConditionEvents) calls, on the contrary to the default case, where each single ArchCondition.check(Object, ConditionEvents) stands for itself.
void	init(Collection<COMPONENT> allComponents)	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.

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

and, as, forSubtype, from, getDescription, or, toString

Methods inherited from class java.lang.Object

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

Method Details

init

public void init(Collection<COMPONENT> allComponents)

Description copied from class: ArchCondition

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.

Overrides:

init in class ArchCondition<COMPONENT>

Parameters:

allComponents - All objects that ArchCondition.check(Object, ConditionEvents) will be called against

check

public void check(COMPONENT component,
 ConditionEvents events)

Specified by:

check in class ArchCondition<COMPONENT>

finish

public void finish(ConditionEvents events)

Description copied from class: ArchCondition

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

Overrides:

finish in class ArchCondition<COMPONENT>

builder

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public static <COMPONENT>
CycleArchCondition.NeedsRetrieveClasses<COMPONENT> builder()