Package com.tngtech.archunit.library.plantuml.rules

Class PlantUmlArchCondition.Configuration

java.lang.Object

com.tngtech.archunit.library.plantuml.rules.PlantUmlArchCondition.Configuration

Enclosing class:

PlantUmlArchCondition

@PublicAPI(usage=ACCESS)
public static final class PlantUmlArchCondition.Configuration
extends Object

Used to specify which dependencies should be checked by the condition. Possible options are:

• consideringAllDependencies()
• consideringOnlyDependenciesInDiagram()
• consideringOnlyDependenciesInAnyPackage(String, String...)

Method Summary

Modifier and Type	Method	Description
static PlantUmlArchCondition.Configuration	consideringAllDependencies()	Considers all dependencies of every imported class, including basic Java classes like Object
static PlantUmlArchCondition.Configuration	consideringOnlyDependenciesInAnyPackage(String packageIdentifier, String... furtherPackageIdentifiers)	Considers only dependencies of the imported classes that have targets in the package identifiers.
static PlantUmlArchCondition.Configuration	consideringOnlyDependenciesInDiagram()	Considers only dependencies of the imported classes that are contained within diagram components.

Methods inherited from class java.lang.Object

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

Method Details

consideringAllDependencies

@PublicAPI(usage=ACCESS)
public static PlantUmlArchCondition.Configuration consideringAllDependencies()

Considers all dependencies of every imported class, including basic Java classes like Object

consideringOnlyDependenciesInDiagram

@PublicAPI(usage=ACCESS)
public static PlantUmlArchCondition.Configuration consideringOnlyDependenciesInDiagram()

Considers only dependencies of the imported classes that are contained within diagram components. This makes it easy to ignore dependencies to irrelevant classes like Object, but bears the danger of missing dependencies to components that have simply been forgotten to be added to the diagram.

consideringOnlyDependenciesInAnyPackage

@PublicAPI(usage=ACCESS)
public static PlantUmlArchCondition.Configuration consideringOnlyDependenciesInAnyPackage(String packageIdentifier,
 String... furtherPackageIdentifiers)

Considers only dependencies of the imported classes that have targets in the package identifiers. This can for example be used to limit checked dependencies to those contained in the own project, e.g. 'com.myapp..'.