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

Interface GivenObjects<T>

All Known Subinterfaces:

GivenClasses, GivenCodeUnits<CODE_UNIT>, GivenConstructors, GivenFields, GivenMembers<MEMBER>, GivenMethods, GivenModules<DESCRIPTOR>, GivenModulesByAnnotation<ANNOTATION>, GivenNamedSlices, GivenSlices

All Known Implementing Classes:

ModuleRuleDefinition.PackagesDefinition, ModuleRuleDefinition.RootClassesDefinition

@PublicAPI(usage=ACCESS)
public interface GivenObjects<T>

Method Summary

Modifier and Type	Method	Description
ArchRule	should(ArchCondition<? super T> condition)	Allows to form a rule by passing a condition the objects under consideration must satisfy.
GivenConjunction<T>	that(DescribedPredicate<? super T> predicate)	Allows to restrict the set of objects under consideration.

Method Details

should

@PublicAPI(usage=ACCESS)
ArchRule should(ArchCondition<? super T> condition)

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

all(customObjects).should(behaveAsExpected())

Returns:

An ArchRule which can be evaluated on imported JavaClasses

that

@PublicAPI(usage=ACCESS)
GivenConjunction<T> that(DescribedPredicate<? super T> predicate)

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.

Returns:

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