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

Class ModuleRuleDefinition.RootClassesDefinition<DESCRIPTOR extends ArchModule.Descriptor>

java.lang.Object

com.tngtech.archunit.library.modules.syntax.ModuleRuleDefinition.RootClassesDefinition<DESCRIPTOR>

All Implemented Interfaces:

GivenObjects<ArchModule<DESCRIPTOR>>, GivenModules<DESCRIPTOR>

Enclosing class:

ModuleRuleDefinition

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public static final class ModuleRuleDefinition.RootClassesDefinition<DESCRIPTOR extends ArchModule.Descriptor>
extends Object
implements GivenModules<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.
<D extends ArchModule.Descriptor> GivenModules<D>	derivingModuleFromRootClassBy(DescribedFunction<? super JavaClass,D> descriptorFunction)
ModulesShould<DESCRIPTOR>	should()	Allows to specify assertions for the set of ArchModules under consideration.
ArchRule	should(ArchCondition<? super ArchModule<DESCRIPTOR>> condition)	Allows to form a rule by passing a condition the objects under consideration must satisfy.
GivenModulesConjunction<DESCRIPTOR>	that(DescribedPredicate<? super ArchModule<DESCRIPTOR>> predicate)	Allows to restrict the set of objects under consideration.

Methods inherited from class java.lang.Object

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

Method Details

derivingModuleFromRootClassBy

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public <D extends ArchModule.Descriptor>
GivenModules<D> derivingModuleFromRootClassBy(DescribedFunction<? super JavaClass,D> descriptorFunction)

See Also:

• ArchModules.CreatorByRootClass.describeModuleByRootClass(ArchModules.RootClassDescriptorCreator)

should

public ArchRule should(ArchCondition<? super ArchModule<DESCRIPTOR>> condition)

Description copied from interface: GivenObjects

Allows to form a rule by passing a condition the objects under consideration must satisfy. E.g.

all(customObjects).should(behaveAsExpected())

Specified by:

should in interface GivenObjects<DESCRIPTOR extends ArchModule.Descriptor>

Returns:

An ArchRule which can be evaluated on imported JavaClasses

that

public 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 GivenModules<DESCRIPTOR extends ArchModule.Descriptor>

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

public ModulesShould<DESCRIPTOR> 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<DESCRIPTOR extends ArchModule.Descriptor>

Returns:

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

as

public GivenModules<DESCRIPTOR> as(String description,
 Object... args)

Description copied from interface: GivenModules

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...".

Specified by:

as in interface GivenModules<DESCRIPTOR extends ArchModule.Descriptor>