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

Interface GivenMembers<MEMBER extends JavaMember>

All Superinterfaces:

GivenObjects<MEMBER>

All Known Subinterfaces:

GivenCodeUnits<CODE_UNIT>, GivenConstructors, GivenFields, GivenMethods

@PublicAPI(usage=ACCESS)
public interface GivenMembers<MEMBER extends JavaMember>
extends GivenObjects<MEMBER>

Method Summary

Modifier and Type	Method	Description
MembersShould<? extends MembersShouldConjunction<MEMBER>>	should()	Allows to specify assertions for the set of members under consideration.
MembersShouldConjunction<MEMBER>	should(ArchCondition<? super MEMBER> condition)	Allows to specify assertions for the set of members under consideration.
MembersThat<? extends GivenMembersConjunction<MEMBER>>	that()	Allows to restrict the set of members under consideration.
GivenMembersConjunction<MEMBER>	that(DescribedPredicate<? super MEMBER> predicate)	Allows to restrict the set of members under consideration.

Method Details

that

@PublicAPI(usage=ACCESS)
MembersThat<? extends GivenMembersConjunction<MEMBER>> that()

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

 members().that().haveName("foo")
 

Returns:

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

that

@PublicAPI(usage=ACCESS)
GivenMembersConjunction<MEMBER> that(DescribedPredicate<? super MEMBER> predicate)

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

 members().that(haveName("foo"))
 

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 JavaMember can be found within JavaMember.Predicates or one of the respective ancestors like HasName.Predicates.

Specified by:

that in interface GivenObjects<MEMBER extends JavaMember>

Returns:

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

should

@PublicAPI(usage=ACCESS)
MembersShould<? extends MembersShouldConjunction<MEMBER>> should()

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

 members().should().haveName("foo")
 

Returns:

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

should

@PublicAPI(usage=ACCESS)
MembersShouldConjunction<MEMBER> should(ArchCondition<? super MEMBER> condition)

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

 members().should(haveName("foo"))
 

Predefined conditions to customize and join can be found within ArchConditions.

Specified by:

should in interface GivenObjects<MEMBER extends JavaMember>

Returns:

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