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

Interface GivenFields

All Superinterfaces:

GivenMembers<JavaField>, GivenObjects<JavaField>

@PublicAPI(usage=ACCESS)
public interface GivenFields
extends GivenMembers<JavaField>

Method Summary

Modifier and Type	Method	Description
FieldsShould<?>	should()	Allows to specify assertions for the set of members under consideration.
FieldsShouldConjunction	should(ArchCondition<? super JavaField> condition)	Allows to specify assertions for the set of members under consideration.
FieldsThat<? extends GivenFieldsConjunction>	that()	Allows to restrict the set of members under consideration.
GivenFieldsConjunction	that(DescribedPredicate<? super JavaField> predicate)	Allows to restrict the set of members under consideration.

Method Details

that

@PublicAPI(usage=ACCESS)
FieldsThat<? extends GivenFieldsConjunction> that()

Description copied from interface: GivenMembers

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

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

Specified by:

that in interface GivenMembers<JavaField>

Returns:

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

that

@PublicAPI(usage=ACCESS)
GivenFieldsConjunction that(DescribedPredicate<? super JavaField> predicate)

Description copied from interface: GivenMembers

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 GivenMembers<JavaField>

Specified by:

that in interface GivenObjects<JavaField>

Returns:

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

should

@PublicAPI(usage=ACCESS)
FieldsShould<?> should()

Description copied from interface: GivenMembers

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

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

Specified by:

should in interface GivenMembers<JavaField>

Returns:

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

should

@PublicAPI(usage=ACCESS)
FieldsShouldConjunction should(ArchCondition<? super JavaField> condition)

Description copied from interface: GivenMembers

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 GivenMembers<JavaField>

Specified by:

should in interface GivenObjects<JavaField>

Returns:

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