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

Interface ClassesShouldConjunction

All Superinterfaces:

ArchRule, CanBeEvaluated, CanOverrideDescription<ArchRule>, HasDescription

@PublicAPI(usage=ACCESS)
public interface ClassesShouldConjunction
extends ArchRule

Allows to join together any existing ArchCondition of this rule with another ArchCondition via and or or. Note that the behavior is always fully left-associative, i.e. there is no "operator precedence" as for && or ||. Take for example

 classes()...should().bePublic().orShould().bePrivate().andShould().haveNameMatching(pattern)
 

The semantics of the new condition will be (public OR private) AND haveNameMatching – and not public || (private && haveNameMatching).

Thus, for more complex conditions please consider explicitly joining preconfigured conditions or custom conditions via ArchCondition.and(ArchCondition) and ArchCondition.or(ArchCondition) where you can freely control the precedence via nesting. E.g.

 classes()...should(
   bePublic().or(
     bePrivate().and(haveNameMatching(pattern))
   )
 )
 

Note that inverting the rule, e.g. via ArchRuleDefinition.noClasses(), will also invert the join operator. I.e. if you define noClasses().should().a().orShould().b() it will mean that all classes must satisfy not(a) AND not(b).

Nested Class Summary

Nested classes/interfaces inherited from interface com.tngtech.archunit.lang.ArchRule

ArchRule.Assertions, ArchRule.Factory, ArchRule.Transformation

Method Summary

Modifier and Type	Method	Description
ClassesShould	andShould()	Like andShould(ArchCondition) but offers a fluent API to pick the condition to join.
ClassesShouldConjunction	andShould(ArchCondition<? super JavaClass> condition)	Joins another condition to this rule with and semantics.
ClassesShould	orShould()	Like orShould(ArchCondition) but offers a fluent API to pick the condition to join.
ClassesShouldConjunction	orShould(ArchCondition<? super JavaClass> condition)	Joins another condition to this rule with or semantics.

Methods inherited from interface com.tngtech.archunit.lang.ArchRule

allowEmptyShould, because, check

Methods inherited from interface com.tngtech.archunit.lang.CanBeEvaluated

evaluate

Methods inherited from interface com.tngtech.archunit.core.domain.properties.CanOverrideDescription

as

Methods inherited from interface com.tngtech.archunit.base.HasDescription

getDescription

Method Details

andShould

@PublicAPI(usage=ACCESS)
ClassesShouldConjunction andShould(ArchCondition<? super JavaClass> condition)

Joins another condition to this rule with and semantics. That is, all classes under test now needs to satisfy the existing condition and this new one.
Note that this is always left-associative and does not support any operator precedence, see ClassesShouldConjunction.

Parameters:

condition - Another condition to be 'and'-ed to the current condition of this rule

Returns:

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

andShould

@PublicAPI(usage=ACCESS)
ClassesShould andShould()

Like andShould(ArchCondition) but offers a fluent API to pick the condition to join.

orShould

@PublicAPI(usage=ACCESS)
ClassesShouldConjunction orShould(ArchCondition<? super JavaClass> condition)

Joins another condition to this rule with or semantics. That is, all classes under test now needs to satisfy the existing condition or this given one.
Note that this is always left-associative and does not support any operator precedence, see ClassesShouldConjunction.

Parameters:

condition - Another condition to be 'and'-ed to the current condition of this rule

Returns:

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

orShould

@PublicAPI(usage=ACCESS)
ClassesShould orShould()

Like orShould(ArchCondition) but offers a fluent API to pick the condition to join.