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

Interface GivenModulesByAnnotationConjunction<ANNOTATION extends Annotation>

All Superinterfaces:

GivenConjunction<ArchModule<AnnotationDescriptor<ANNOTATION>>>, GivenModulesConjunction<AnnotationDescriptor<ANNOTATION>>

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

Method Summary

Modifier and Type	Method	Description
GivenModulesByAnnotationConjunction<ANNOTATION>	and(DescribedPredicate<? super ArchModule<AnnotationDescriptor<ANNOTATION>>> predicate)	Combines the current predicate (e.g.
GivenModulesByAnnotationConjunction<ANNOTATION>	as(String description, Object... args)
GivenModulesByAnnotationConjunction<ANNOTATION>	or(DescribedPredicate<? super ArchModule<AnnotationDescriptor<ANNOTATION>>> predicate)	Combines the current predicate (e.g.
ModulesByAnnotationShould<ANNOTATION>	should()

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

should

Method Details

and

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
GivenModulesByAnnotationConjunction<ANNOTATION> and(DescribedPredicate<? super ArchModule<AnnotationDescriptor<ANNOTATION>>> predicate)

Description copied from interface: GivenConjunction

Combines the current predicate (e.g. simpleName == 'SomeClass') with another predicate (e.g. resideInAPackage 'foo.bar') using AND (i.e. both predicates must be satisfied).

NOTE: GivenConjunction.and(DescribedPredicate) and GivenConjunction.or(DescribedPredicate) combine predicates in the sequence they are declared, without any "operator precedence". I.e.

 all(objects()).that(predicateA).or(predicateB).and(predicateC)...
 

will filter on predicate (predicateA || predicateB) && predicateC, and

 all(objects()).that(predicateA).and(predicateB).or(predicateC)...
 

will filter on predicate (predicateA && predicateB) || predicateC. If you need more control over the precedence, how predicates are joined, you have to join these predicates separately, i.e.

 all(objects()).that(predicateA.or(predicateB.and(predicateC)))...
 

Specified by:

and in interface GivenConjunction<ANNOTATION extends Annotation>

Specified by:

and in interface GivenModulesConjunction<ANNOTATION extends Annotation>

Parameters:

predicate - The predicate to be ANDed on the current object filter predicate

Returns:

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

or

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
GivenModulesByAnnotationConjunction<ANNOTATION> or(DescribedPredicate<? super ArchModule<AnnotationDescriptor<ANNOTATION>>> predicate)

Description copied from interface: GivenConjunction

Combines the current predicate (e.g. simpleName == 'SomeClass') with another predicate (e.g. resideInAPackage 'foo.bar') using OR (i.e. at least one of the predicates must be satisfied).

NOTE: For considerations about precedence, when joining predicates, consider note at GivenConjunction.and(DescribedPredicate)

Specified by:

or in interface GivenConjunction<ANNOTATION extends Annotation>

Specified by:

or in interface GivenModulesConjunction<ANNOTATION extends Annotation>

Parameters:

predicate - The predicate to be ORed on the current object filter predicate

Returns:

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

should

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

Specified by:

should in interface GivenModulesConjunction<ANNOTATION extends Annotation>

See Also:

• GivenModules.should()

as

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

Specified by:

as in interface GivenModulesConjunction<ANNOTATION extends Annotation>

See Also:

• GivenModules.as(String, Object...)