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

Class CycleArchCondition.Builder<COMPONENT>

java.lang.Object

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

All Implemented Interfaces:

CycleArchCondition.NeedsRetrieveClasses<COMPONENT>, CycleArchCondition.NeedsRetrieveDescription<COMPONENT>, CycleArchCondition.NeedsRetrieveOutgoingDependencies<COMPONENT>

Enclosing class:

CycleArchCondition<COMPONENT>

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public static final class CycleArchCondition.Builder<COMPONENT>
extends Object
implements CycleArchCondition.NeedsRetrieveClasses<COMPONENT>, CycleArchCondition.NeedsRetrieveDescription<COMPONENT>, CycleArchCondition.NeedsRetrieveOutgoingDependencies<COMPONENT>

Method Summary

Modifier and Type	Method	Description
CycleArchCondition<COMPONENT>	build()
CycleArchCondition.Builder<COMPONENT>	onlyConsiderDependencies(Predicate<? super Dependency> relevantClassDependenciesPredicate)
CycleArchCondition.NeedsRetrieveDescription<COMPONENT>	retrieveClassesBy(Function<? super COMPONENT,Iterable<JavaClass>> retrieveClasses)
CycleArchCondition.NeedsRetrieveOutgoingDependencies<COMPONENT>	retrieveDescriptionBy(Function<? super COMPONENT,String> retrieveDescription)
CycleArchCondition.Builder<COMPONENT>	retrieveOutgoingDependenciesBy(Function<? super COMPONENT,Set<Dependency>> retrieveOutgoingDependencies)

Methods inherited from class java.lang.Object

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

Method Details

retrieveClassesBy

public CycleArchCondition.NeedsRetrieveDescription<COMPONENT> retrieveClassesBy(Function<? super COMPONENT,Iterable<JavaClass>> retrieveClasses)

Specified by:

retrieveClassesBy in interface CycleArchCondition.NeedsRetrieveClasses<COMPONENT>

Parameters:

retrieveClasses - A Function to retrieve the contained classes for any given COMPONENT

retrieveDescriptionBy

public CycleArchCondition.NeedsRetrieveOutgoingDependencies<COMPONENT> retrieveDescriptionBy(Function<? super COMPONENT,String> retrieveDescription)

Specified by:

retrieveDescriptionBy in interface CycleArchCondition.NeedsRetrieveDescription<COMPONENT>

Parameters:

retrieveDescription - A Function to retrieve the description of a COMPONENT

retrieveOutgoingDependenciesBy

public CycleArchCondition.Builder<COMPONENT> retrieveOutgoingDependenciesBy(Function<? super COMPONENT,Set<Dependency>> retrieveOutgoingDependencies)

Specified by:

retrieveOutgoingDependenciesBy in interface CycleArchCondition.NeedsRetrieveOutgoingDependencies<COMPONENT>

Parameters:

retrieveOutgoingDependencies - A Function to retrieve the outgoing dependencies of a COMPONENT

onlyConsiderDependencies

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public CycleArchCondition.Builder<COMPONENT> onlyConsiderDependencies(Predicate<? super Dependency> relevantClassDependenciesPredicate)

Parameters:

relevantClassDependenciesPredicate - A Predicate to decide which dependencies are relevant when checking for cycles

build

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public CycleArchCondition<COMPONENT> build()

Returns:

A new CycleArchCondition