Package com.tngtech.archunit.lang.syntax.elements

Interface GivenClasses

All Superinterfaces:

GivenObjects<JavaClass>

@PublicAPI(usage=ACCESS)
public interface GivenClasses
extends GivenObjects<JavaClass>

Method Summary

Modifier and Type	Method	Description
ClassesShould	should()	Allows to specify assertions for the set of classes under consideration.
ClassesShouldConjunction	should(ArchCondition<? super JavaClass> condition)	Allows to specify assertions for the set of classes under consideration.
ClassesThat<GivenClassesConjunction>	that()	Allows to restrict the set of classes under consideration.
GivenClassesConjunction	that(DescribedPredicate<? super JavaClass> predicate)	Allows to restrict the set of classes under consideration.

Method Details

that

@PublicAPI(usage=ACCESS)
ClassesThat<GivenClassesConjunction> that()

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

classes().that().haveSimpleName("Example")

Returns:

A syntax element, which can be used to restrict the classes under consideration

that

@PublicAPI(usage=ACCESS)
GivenClassesConjunction that(DescribedPredicate<? super JavaClass> predicate)

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

classes().that(haveSimpleName("Example")) 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<JavaClass>

Returns:

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

should

@PublicAPI(usage=ACCESS)
ClassesShould should()

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

classes().should().haveSimpleName("Example")
Use should(ArchCondition) to freely customize the condition against which the classes should be checked.

Returns:

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

should

@PublicAPI(usage=ACCESS)
ClassesShouldConjunction should(ArchCondition<? super JavaClass> condition)

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

classes().should(haveSimpleName("Example")) should() is a fluent version of this API that allows your IDE to make suggestions.
Predefined conditions to customize and join can be found within ArchConditions.

Specified by:

should in interface GivenObjects<JavaClass>

Returns:

A syntax element, which can be used to restrict the classes under consideration