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

Class PlantUmlArchCondition

java.lang.Object

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

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

@PublicAPI(usage=ACCESS)
public final class PlantUmlArchCondition
extends ArchCondition<JavaClass>

Allows to evaluate PlantUML Component Diagrams as ArchUnit rules.

The general syntax to use is

 classes().should(adhereToPlantUmlDiagram(someDiagramUrl, consideringAllDependencies()));
 

The supported diagram syntax uses component diagram stereotypes to associate package patterns (compare PackageMatcher) with components. An example could look like

 [Some Source] <<..some.source..>>
 [Some Target] <<..some.target..>>

 [Some Source] --> [Some Target]
 

Applying such a diagram as an ArchUnit rule would demand dependencies only from ..some.source.. to ..some.target.., but forbid them vice versa.
There are various factory method for different input formats (file, url, ...), compare

• adhereToPlantUmlDiagram(URL, Configuration)
• adhereToPlantUmlDiagram(File, Configuration)
• adhereToPlantUmlDiagram(Path, Configuration)
• adhereToPlantUmlDiagram(String, Configuration)

Which dependencies should be considered by the rule can be configured via PlantUmlArchCondition.Configuration. Candidates are

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

A PlantUML diagram used with ArchUnit must abide by a certain set of rules:

1. Components must have a name
2. Components must have at least one stereotype. Each stereotype in the diagram must be unique
3. Components may have an optional alias
4. Components may have an optional color
5. Components must be defined before declaring dependencies
6. Dependencies must use arrows only consisting of dashes, pointing right, e.g. -->

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PlantUmlArchCondition.Configuration	Used to specify which dependencies should be checked by the condition.

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 PlantUmlArchCondition	adhereToPlantUmlDiagram(File file, PlantUmlArchCondition.Configuration configuration)
static PlantUmlArchCondition	adhereToPlantUmlDiagram(String fileName, PlantUmlArchCondition.Configuration configuration)
static PlantUmlArchCondition	adhereToPlantUmlDiagram(URL url, PlantUmlArchCondition.Configuration configuration)
static PlantUmlArchCondition	adhereToPlantUmlDiagram(Path path, PlantUmlArchCondition.Configuration configuration)
void	check(JavaClass javaClass, ConditionEvents events)
PlantUmlArchCondition	ignoreDependencies(DescribedPredicate<? super Dependency> ignorePredicate)	Ignores all dependencies matching the supplied ignorePredicate.
PlantUmlArchCondition	ignoreDependencies(Class<?> origin, Class<?> target)
PlantUmlArchCondition	ignoreDependencies(String origin, String target)
PlantUmlArchCondition	ignoreDependenciesWithOrigin(DescribedPredicate<? super JavaClass> ignorePredicate)	Ignores all dependencies that have an origin class matching the supplied ignorePredicate.
PlantUmlArchCondition	ignoreDependenciesWithTarget(DescribedPredicate<? super JavaClass> ignorePredicate)	Ignores all dependencies that have an target class matching the supplied ignorePredicate.

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

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

Methods inherited from class java.lang.Object

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

Method Details

ignoreDependenciesWithOrigin

@PublicAPI(usage=ACCESS)
public PlantUmlArchCondition ignoreDependenciesWithOrigin(DescribedPredicate<? super JavaClass> ignorePredicate)

Ignores all dependencies that have an origin class matching the supplied ignorePredicate.

Note that many predefined predicates can be found within a subclass Predicates of the respective domain object or a common ancestor. For example, predicates targeting JavaClass can be found within JavaClass.Predicates or one of the respective ancestors like HasName.Predicates.

ignoreDependenciesWithTarget

@PublicAPI(usage=ACCESS)
public PlantUmlArchCondition ignoreDependenciesWithTarget(DescribedPredicate<? super JavaClass> ignorePredicate)

Ignores all dependencies that have an target class matching the supplied ignorePredicate.

Note that many predefined predicates can be found within a subclass Predicates of the respective domain object or a common ancestor. For example, predicates targeting JavaClass can be found within JavaClass.Predicates or one of the respective ancestors like HasName.Predicates.

ignoreDependencies

@PublicAPI(usage=ACCESS)
public PlantUmlArchCondition ignoreDependencies(Class<?> origin,
 Class<?> target)

ignoreDependencies

@PublicAPI(usage=ACCESS)
public PlantUmlArchCondition ignoreDependencies(String origin,
 String target)

ignoreDependencies

@PublicAPI(usage=ACCESS)
public PlantUmlArchCondition ignoreDependencies(DescribedPredicate<? super Dependency> ignorePredicate)

Ignores all dependencies matching the supplied ignorePredicate.

Note that many predefined predicates can be found within a subclass Predicates of the respective domain object or a common ancestor. For example, predicates targeting Dependency can be found within Dependency.Predicates.

check

public void check(JavaClass javaClass,
 ConditionEvents events)

Specified by:

check in class ArchCondition<JavaClass>

adhereToPlantUmlDiagram

@PublicAPI(usage=ACCESS)
public static PlantUmlArchCondition adhereToPlantUmlDiagram(URL url,
 PlantUmlArchCondition.Configuration configuration)

See Also:

• PlantUmlArchCondition

adhereToPlantUmlDiagram

@PublicAPI(usage=ACCESS)
public static PlantUmlArchCondition adhereToPlantUmlDiagram(String fileName,
 PlantUmlArchCondition.Configuration configuration)

See Also:

• PlantUmlArchCondition

adhereToPlantUmlDiagram

@PublicAPI(usage=ACCESS)
public static PlantUmlArchCondition adhereToPlantUmlDiagram(Path path,
 PlantUmlArchCondition.Configuration configuration)

See Also:

• PlantUmlArchCondition

adhereToPlantUmlDiagram

@PublicAPI(usage=ACCESS)
public static PlantUmlArchCondition adhereToPlantUmlDiagram(File file,
 PlantUmlArchCondition.Configuration configuration)

See Also:

• PlantUmlArchCondition