Package com.tngtech.archunit.library.dependencies

Class SliceRule

java.lang.Object

com.tngtech.archunit.library.dependencies.SliceRule

All Implemented Interfaces:

HasDescription, CanOverrideDescription<ArchRule>, ArchRule, CanBeEvaluated

@PublicAPI(usage=ACCESS)
public final class SliceRule
extends Object
implements ArchRule

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
ArchRule	allowEmptyShould(boolean allowEmptyShould)	If set to true allows the should-clause of this rule to be checked against an empty set of elements.
SliceRule	as(String newDescription)	Allows to adjust the description of this object.
SliceRule	because(String reason)
void	check(JavaClasses classes)
EvaluationResult	evaluate(JavaClasses classes)
String	getDescription()
SliceRule	ignoreDependency(DescribedPredicate<? super JavaClass> origin, DescribedPredicate<? super JavaClass> target)
SliceRule	ignoreDependency(Class<?> origin, Class<?> target)
SliceRule	ignoreDependency(String origin, String target)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

check

@PublicAPI(usage=ACCESS)
public void check(JavaClasses classes)

Specified by:

check in interface ArchRule

because

@PublicAPI(usage=ACCESS)
public SliceRule because(String reason)

Specified by:

because in interface ArchRule

allowEmptyShould

@PublicAPI(usage=ACCESS)
public ArchRule allowEmptyShould(boolean allowEmptyShould)

Description copied from interface: ArchRule

If set to true allows the should-clause of this rule to be checked against an empty set of elements. Otherwise, the rule will fail with a respective message. This is to prevent possible implementation errors, like filtering for a non-existing package in the that-clause causing an always-passing rule.
Note that this method will override the configuration property archRule.failOnEmptyShould.

Specified by:

allowEmptyShould in interface ArchRule

Parameters:

allowEmptyShould - Whether the rule fails if the should-clause is evaluated with an empty set of elements

Returns:

A (new) ArchRule with adjusted allowEmptyShould behavior

evaluate

@PublicAPI(usage=ACCESS)
public EvaluationResult evaluate(JavaClasses classes)

Specified by:

evaluate in interface CanBeEvaluated

getDescription

@PublicAPI(usage=ACCESS)
public String getDescription()

Specified by:

getDescription in interface HasDescription

as

@PublicAPI(usage=ACCESS)
public SliceRule as(String newDescription)

Description copied from interface: CanOverrideDescription

Allows to adjust the description of this object. Note that this method will not modify the current object, but instead return a new object with adjusted description.

Specified by:

as in interface CanOverrideDescription<ArchRule>

Parameters:

newDescription - The description the result of this method will hold

Returns:

A new equivalent object with adjusted description

ignoreDependency

@PublicAPI(usage=ACCESS)
public SliceRule ignoreDependency(Class<?> origin,
 Class<?> target)

ignoreDependency

@PublicAPI(usage=ACCESS)
public SliceRule ignoreDependency(String origin,
 String target)

ignoreDependency

@PublicAPI(usage=ACCESS)
public SliceRule ignoreDependency(DescribedPredicate<? super JavaClass> origin,
 DescribedPredicate<? super JavaClass> target)

toString

public String toString()

Overrides:

toString in class Object