Package com.tngtech.archunit.library.modules.syntax

Class ModuleDependencyScope

java.lang.Object

com.tngtech.archunit.library.modules.syntax.ModuleDependencyScope

All Implemented Interfaces:

HasDescription

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public final class ModuleDependencyScope
extends Object
implements HasDescription

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

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

Method Summary

Modifier and Type	Method	Description
static ModuleDependencyScope	consideringAllDependencies()	Considers all dependencies of every imported class, including basic Java classes like Object.
static ModuleDependencyScope	consideringOnlyDependenciesBetweenModules()	Considers only dependencies of the imported classes between two modules.
static ModuleDependencyScope	consideringOnlyDependenciesInAnyPackage(String packageIdentifier, String... furtherPackageIdentifiers)	Considers only dependencies of imported classes that target packages matching the given the package identifiers.
String	getDescription()

Methods inherited from class java.lang.Object

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

Method Details

getDescription

public String getDescription()

Specified by:

getDescription in interface HasDescription

consideringAllDependencies

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public static ModuleDependencyScope consideringAllDependencies()

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

See Also:

• consideringOnlyDependenciesBetweenModules()
• consideringOnlyDependenciesInAnyPackage(String, String...)

consideringOnlyDependenciesBetweenModules

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public static ModuleDependencyScope consideringOnlyDependenciesBetweenModules()

Considers only dependencies of the imported classes between two modules. I.e. origin and target classes of the dependency must be contained within modules under test to be considered. This makes it easy to ignore dependencies to irrelevant classes like Object, but bears the danger of missing dependencies to classes that are falsely not covered by the declared module structure.

See Also:

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

consideringOnlyDependenciesInAnyPackage

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public static ModuleDependencyScope consideringOnlyDependenciesInAnyPackage(String packageIdentifier,
 String... furtherPackageIdentifiers)

Considers only dependencies of imported classes that target packages matching the given the package identifiers. This can for example be used to limit checked dependencies to those contained in the own project, e.g. 'com.myapp..'.
Note that module dependencies, i.e. dependencies between two modules, will never be filtered, so this ModuleDependencyScope will never limit the amount of considered dependencies more than consideringOnlyDependenciesBetweenModules().

See Also:

• consideringAllDependencies()
• consideringOnlyDependenciesBetweenModules()