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

Interface GivenModulesByAnnotation<ANNOTATION extends Annotation>

All Superinterfaces:

GivenModules<AnnotationDescriptor<ANNOTATION>>, GivenObjects<ArchModule<AnnotationDescriptor<ANNOTATION>>>

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public interface GivenModulesByAnnotation<ANNOTATION extends Annotation>
extends GivenModules<AnnotationDescriptor<ANNOTATION>>

Method Summary

Modifier and Type	Method	Description
ModulesByAnnotationShould<ANNOTATION>	should()	Allows to specify assertions for the set of ArchModules under consideration.
GivenModulesByAnnotationConjunction<ANNOTATION>	that(DescribedPredicate<? super ArchModule<AnnotationDescriptor<ANNOTATION>>> predicate)	Allows to restrict the set of objects under consideration.

Methods inherited from interface com.tngtech.archunit.library.modules.syntax.GivenModules

as

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

should

Method Details

that

GivenModulesByAnnotationConjunction<ANNOTATION> that(DescribedPredicate<? super ArchModule<AnnotationDescriptor<ANNOTATION>>> 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 GivenModules<ANNOTATION extends Annotation>

Specified by:

that in interface GivenObjects<ANNOTATION extends Annotation>

Returns:

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

should

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
ModulesByAnnotationShould<ANNOTATION> should()

Description copied from interface: GivenModules

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.

Specified by:

should in interface GivenModules<ANNOTATION extends Annotation>

Returns:

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