Package com.tngtech.archunit.library.dependencies.syntax

Interface GivenSlicesConjunction

All Superinterfaces:

GivenConjunction<Slice>

@PublicAPI(usage=ACCESS)
public interface GivenSlicesConjunction
extends GivenConjunction<Slice>

Method Summary

Modifier and Type	Method	Description
GivenSlicesConjunction	and(DescribedPredicate<? super Slice> predicate)	Combines the current predicate (e.g.
GivenSlicesConjunction	as(String description)	Customizes the description of the slices under test, i.e.
GivenSlicesConjunction	or(DescribedPredicate<? super Slice> predicate)	Combines the current predicate (e.g.
SlicesShould	should()	Like GivenConjunction.should(ArchCondition) but allows to pick the ArchCondition by a fluent API.

Methods inherited from interface com.tngtech.archunit.lang.syntax.elements.GivenConjunction

should

Method Details

should

@PublicAPI(usage=ACCESS)
SlicesShould should()

Like GivenConjunction.should(ArchCondition) but allows to pick the ArchCondition by a fluent API.

and

@PublicAPI(usage=ACCESS)
GivenSlicesConjunction and(DescribedPredicate<? super Slice> 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<Slice>

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)
GivenSlicesConjunction or(DescribedPredicate<? super Slice> 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<Slice>

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

as

@PublicAPI(usage=ACCESS)
GivenSlicesConjunction as(String description)

Customizes the description of the slices under test, i.e. the part before the 'should' of the ArchRule. E.g.

 slices().matching("..some.pattern.(*)..").as("My specific components").should()...
 

yields the rule text My specific components should...

Parameters:

description - The description of the slices within the slice rule

Returns:

A syntax element, which can be used to restrict the classes under consideration or form a complete ArchRule