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

Interface GivenModules<DESCRIPTOR extends ArchModule.Descriptor>

All Superinterfaces:

GivenObjects<ArchModule<DESCRIPTOR>>

All Known Subinterfaces:

GivenModulesByAnnotation<ANNOTATION>

All Known Implementing Classes:

ModuleRuleDefinition.PackagesDefinition, ModuleRuleDefinition.RootClassesDefinition

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

Method Summary

Modifier and Type	Method	Description
GivenModules<DESCRIPTOR>	as(String description, Object... args)	Allows to adjust the description of the "given modules" part.
ModulesShould<DESCRIPTOR>	should()	Allows to specify assertions for the set of ArchModules under consideration.
GivenModulesConjunction<DESCRIPTOR>	that(DescribedPredicate<? super ArchModule<DESCRIPTOR>> predicate)	Allows to restrict the set of objects under consideration.

Methods inherited from interface com.tngtech.archunit.lang.syntax.elements.GivenObjects

should

Method Details

that

GivenModulesConjunction<DESCRIPTOR> that(DescribedPredicate<? super ArchModule<DESCRIPTOR>> predicate)

Description copied from interface: GivenObjects

Allows to restrict the set of objects under consideration. E.g.

all(customObjects).that(predicate) 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.

Specified by:

that in interface GivenObjects<DESCRIPTOR extends ArchModule.Descriptor>

Returns:

A syntax conjunction element, which can be completed to form a full rule

should

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
ModulesShould<DESCRIPTOR> should()

Allows to specify assertions for the set of ArchModules under consideration. E.g.

modules().should().respectTheirAllowedDependencies(..)
Use GivenObjects.should(ArchCondition) to freely customize the condition against which the ArchModules should be checked.

Returns:

A syntax element, which can be used to create rules for the ArchModules under consideration

as

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
GivenModules<DESCRIPTOR> as(String description,
 Object... args)

Allows to adjust the description of the "given modules" part. E.g.

 modules().definedByAnnotation(AppModule.class).as("App Modules").should()...
 

would yield a rule text "App Modules should...".