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

Interface GivenFieldsConjunction

All Superinterfaces:

GivenConjunction<JavaField>, GivenMembersConjunction<JavaField>

@PublicAPI(usage=ACCESS)
public interface GivenFieldsConjunction
extends GivenMembersConjunction<JavaField>

Method Summary

Modifier and Type	Method	Description
FieldsThat<? extends GivenFieldsConjunction>	and()	Like GivenMembersConjunction.and(DescribedPredicate) but allows to pick the predicate to join by a fluent API.
GivenFieldsConjunction	and(DescribedPredicate<? super JavaField> predicate)	Combines the current predicate (e.g.
FieldsThat<? extends GivenFieldsConjunction>	or()	Like GivenMembersConjunction.or(DescribedPredicate) but allows to pick the predicate to join by a fluent API.
GivenFieldsConjunction	or(DescribedPredicate<? super JavaField> predicate)	Combines the current predicate (e.g.
FieldsShould<?>	should()	Like GivenMembersConjunction.should(ArchCondition) but allows to pick the condition to join by a fluent API.
FieldsShouldConjunction	should(ArchCondition<? super JavaField> condition)	Creates an ArchRule that will evaluate all OBJECTS under test against the supplied ArchCondition.

Method Details

and

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

Description copied from interface: GivenMembersConjunction

Like GivenMembersConjunction.and(DescribedPredicate) but allows to pick the predicate to join by a fluent API.

Specified by:

and in interface GivenMembersConjunction<JavaField>

or

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

Description copied from interface: GivenMembersConjunction

Like GivenMembersConjunction.or(DescribedPredicate) but allows to pick the predicate to join by a fluent API.

Specified by:

or in interface GivenMembersConjunction<JavaField>

and

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

Description copied from interface: GivenConjunction

Combines the current predicate (e.g. simpleName == 'SomeClass') with another predicate (e.g. resideInAPackage 'foo.bar') using AND (i.e. both predicates must be satisfied).

NOTE: GivenConjunction.and(DescribedPredicate) and GivenConjunction.or(DescribedPredicate) combine predicates in the sequence they are declared, without any "operator precedence". I.e.

 all(objects()).that(predicateA).or(predicateB).and(predicateC)...
 

will filter on predicate (predicateA || predicateB) && predicateC, and

 all(objects()).that(predicateA).and(predicateB).or(predicateC)...
 

will filter on predicate (predicateA && predicateB) || predicateC. If you need more control over the precedence, how predicates are joined, you have to join these predicates separately, i.e.

 all(objects()).that(predicateA.or(predicateB.and(predicateC)))...
 

Specified by:

and in interface GivenConjunction<JavaField>

Specified by:

and in interface GivenMembersConjunction<JavaField>

Parameters:

predicate - The predicate to be ANDed on the current object filter predicate

Returns:

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

or

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

Description copied from interface: GivenConjunction

Combines the current predicate (e.g. simpleName == 'SomeClass') with another predicate (e.g. resideInAPackage 'foo.bar') using OR (i.e. at least one of the predicates must be satisfied).

NOTE: For considerations about precedence, when joining predicates, consider note at GivenConjunction.and(DescribedPredicate)

Specified by:

or in interface GivenConjunction<JavaField>

Specified by:

or in interface GivenMembersConjunction<JavaField>

Parameters:

predicate - The predicate to be ORed on the current object filter predicate

Returns:

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

should

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

Description copied from interface: GivenConjunction

Creates an ArchRule that will evaluate all OBJECTS under test against the supplied ArchCondition.

Specified by:

should in interface GivenConjunction<JavaField>

Specified by:

should in interface GivenMembersConjunction<JavaField>

Parameters:

condition - The ArchCondition to check objects against

Returns:

An ArchRule that can be checked against a set of OBJECTS

should

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

Description copied from interface: GivenMembersConjunction

Like GivenMembersConjunction.should(ArchCondition) but allows to pick the condition to join by a fluent API.

Specified by:

should in interface GivenMembersConjunction<JavaField>