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

Interface ModulesShould<DESCRIPTOR extends ArchModule.Descriptor>

All Known Subinterfaces:

ModulesByAnnotationShould<ANNOTATION>

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public interface ModulesShould<DESCRIPTOR extends ArchModule.Descriptor>

Method Summary

Modifier and Type	Method	Description
ModulesRule<DESCRIPTOR>	beFreeOfCycles()	Checks that the ArchModules under consideration don't have any cyclic dependencies within their module dependencies.
ClassesThat<ModulesRule<DESCRIPTOR>>	onlyDependOnEachOtherThroughClassesThat()	Like onlyDependOnEachOtherThroughClassesThat(DescribedPredicate) but allows to specify the predicate in a fluent way.
ModulesRule<DESCRIPTOR>	onlyDependOnEachOtherThroughClassesThat(DescribedPredicate<? super JavaClass> predicate)	Checks that the target classes of each Dependency that originate from one ArchModule and target another ArchModule satisfy the passed predicate.
ModulesRule<DESCRIPTOR>	respectTheirAllowedDependencies(DescribedPredicate<? super ModuleDependency<DESCRIPTOR>> allowedDependencyPredicate, ModuleDependencyScope dependencyScope)	Creates a rule to check that the ArchModules under consideration don't have any forbidden module dependencies according to the passed allowedDependencyPredicate.
ModulesRule<DESCRIPTOR>	respectTheirAllowedDependencies(AllowedModuleDependencies allowedDependencies, ModuleDependencyScope dependencyScope)	Convenience API for respectTheirAllowedDependencies(DescribedPredicate, ModuleDependencyScope) that allows to statically define which modules may depend on which other modules by module name.

Method Details

respectTheirAllowedDependencies

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
ModulesRule<DESCRIPTOR> respectTheirAllowedDependencies(DescribedPredicate<? super ModuleDependency<DESCRIPTOR>> allowedDependencyPredicate,
 ModuleDependencyScope dependencyScope)

Creates a rule to check that the ArchModules under consideration don't have any forbidden module dependencies according to the passed allowedDependencyPredicate. It is possible to adjust which class dependencies the rule considers relevant by the passed dependencyScope.

Parameters:

allowedDependencyPredicate - Decides which module dependencies are allowed. If the DescribedPredicate returns true the dependency is allowed, otherwise it is forbidden.

dependencyScope - Allows to adjust which dependencies are considered relevant by the rule

Returns:

An ArchRule to be checked against a set of JavaClasses

respectTheirAllowedDependencies

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
ModulesRule<DESCRIPTOR> respectTheirAllowedDependencies(AllowedModuleDependencies allowedDependencies,
 ModuleDependencyScope dependencyScope)

Convenience API for respectTheirAllowedDependencies(DescribedPredicate, ModuleDependencyScope) that allows to statically define which modules may depend on which other modules by module name.

Example:

 modules()
   .definedByPackages("..example.(*)..")
   .should().respectTheirAllowedDependencies(
     AllowedModuleDependencies.allow()
       .fromModule("Module One").toModules("Module Three", "Module Four")
       .fromModule("Module Two").toModules("Module Four"),
     consideringOnlyDependenciesInAnyPackage("..example.."));
 

onlyDependOnEachOtherThroughClassesThat

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
ModulesRule<DESCRIPTOR> onlyDependOnEachOtherThroughClassesThat(DescribedPredicate<? super JavaClass> predicate)

Checks that the target classes of each Dependency that originate from one ArchModule and target another ArchModule satisfy the passed predicate.

Parameters:

predicate - A DescribedPredicate to determine which target classes of dependencies are allowed.

Returns:

An ArchRule to be checked against a set of JavaClasses

onlyDependOnEachOtherThroughClassesThat

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
ClassesThat<ModulesRule<DESCRIPTOR>> onlyDependOnEachOtherThroughClassesThat()

Like onlyDependOnEachOtherThroughClassesThat(DescribedPredicate) but allows to specify the predicate in a fluent way.

beFreeOfCycles

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
ModulesRule<DESCRIPTOR> beFreeOfCycles()

Checks that the ArchModules under consideration don't have any cyclic dependencies within their module dependencies.

Returns:

An ArchRule to be checked against a set of JavaClasses