Package com.tngtech.archunit.library

Class Architectures.LayeredArchitecture

java.lang.Object

com.tngtech.archunit.library.Architectures.LayeredArchitecture

All Implemented Interfaces:

HasDescription, CanOverrideDescription<ArchRule>, ArchRule, CanBeEvaluated

Enclosing class:

Architectures

@PublicAPI(usage=ACCESS)
public static final class Architectures.LayeredArchitecture
extends Object
implements ArchRule

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Architectures.LayeredArchitecture.DependencySettings	Defines which dependencies the layered architecture will consider when checking for violations.
final class	Architectures.LayeredArchitecture.LayerDefinition
final class	Architectures.LayeredArchitecture.LayerDependencySpecification

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)	This method is equivalent to calling withOptionalLayers(boolean), which should be preferred in this context as the meaning is easier to understand.
Architectures.LayeredArchitecture	as(String newDescription)	Allows to adjust the description of this object.
ArchRule	because(String reason)
void	check(JavaClasses classes)
Architectures.LayeredArchitecture	ensureAllClassesAreContainedInArchitecture()	Ensure that all classes under test are contained within a defined layer of the architecture.
Architectures.LayeredArchitecture	ensureAllClassesAreContainedInArchitectureIgnoring(DescribedPredicate<? super JavaClass> predicate)	Like ensureAllClassesAreContainedInArchitecture() but will ignore classes in packages matching the specified predicate.
Architectures.LayeredArchitecture	ensureAllClassesAreContainedInArchitectureIgnoring(String... packageIdentifiers)	Like ensureAllClassesAreContainedInArchitecture() but will ignore classes in packages matching the specified packageIdentifiers.
EvaluationResult	evaluate(JavaClasses classes)
String	getDescription()
Architectures.LayeredArchitecture	ignoreDependency(DescribedPredicate<? super JavaClass> origin, DescribedPredicate<? super JavaClass> target)	Same as ignoreDependency(Class, Class) but allows specifying origin and target by freely defined predicates.
Architectures.LayeredArchitecture	ignoreDependency(Class<?> origin, Class<?> target)	Configures the rule to ignore any violation from a specific origin class to a specific target class.
Architectures.LayeredArchitecture	ignoreDependency(String originFullyQualifiedClassName, String targetFullyQualifiedClassName)	Same as ignoreDependency(Class, Class) but allows specifying origin and target as fully qualified class names.
Architectures.LayeredArchitecture.LayerDefinition	layer(String name)	Starts the definition of a new layer within the current LayeredArchitecture.
Architectures.LayeredArchitecture.LayerDefinition	optionalLayer(String name)	Starts the definition of a new optional layer within the current LayeredArchitecture.
String	toString()
Architectures.LayeredArchitecture.LayerDependencySpecification	whereLayer(String name)	Allows restricting accesses to or from this layer.
Architectures.LayeredArchitecture	withOptionalLayers(boolean optionalLayers)	By default, layers defined with layer(String) must not be empty, i.e.

Methods inherited from class java.lang.Object

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

Method Details

withOptionalLayers

@PublicAPI(usage=ACCESS)
public Architectures.LayeredArchitecture withOptionalLayers(boolean optionalLayers)

By default, layers defined with layer(String) must not be empty, i.e. contain at least one class.
withOptionalLayers(true) can be used to make all layers optional.
withOptionalLayers(false) still allows to define individual optional layers with optionalLayer(String).

See Also:

• optionalLayer(String)

layer

@PublicAPI(usage=ACCESS)
public Architectures.LayeredArchitecture.LayerDefinition layer(String name)

Starts the definition of a new layer within the current LayeredArchitecture.
Unless withOptionalLayers(true} is used, this layer must not be empty.

See Also:

• optionalLayer(String)

optionalLayer

@PublicAPI(usage=ACCESS)
public Architectures.LayeredArchitecture.LayerDefinition optionalLayer(String name)

Starts the definition of a new optional layer within the current LayeredArchitecture.
An optional layer will not fail if it is empty, i.e. does not contain any classes. When withOptionalLayers(true) is used, all layers are optional by default, such that there is no difference between optionalLayer(String) and layer(String) anymore

getDescription

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

Specified by:

getDescription in interface HasDescription

toString

public String toString()

Overrides:

toString in class Object

evaluate

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

Specified by:

evaluate in interface CanBeEvaluated

ensureAllClassesAreContainedInArchitecture

@PublicAPI(usage=ACCESS)
public Architectures.LayeredArchitecture ensureAllClassesAreContainedInArchitecture()

Ensure that all classes under test are contained within a defined layer of the architecture.

See Also:

• ensureAllClassesAreContainedInArchitectureIgnoring(String...)
• ensureAllClassesAreContainedInArchitectureIgnoring(DescribedPredicate)

ensureAllClassesAreContainedInArchitectureIgnoring

@PublicAPI(usage=ACCESS)
public Architectures.LayeredArchitecture ensureAllClassesAreContainedInArchitectureIgnoring(String... packageIdentifiers)

Like ensureAllClassesAreContainedInArchitecture() but will ignore classes in packages matching the specified packageIdentifiers.

Parameters:

packageIdentifiers - packageIdentifiers specifying which classes may live outside the architecture

See Also:

• ensureAllClassesAreContainedInArchitecture()
• ensureAllClassesAreContainedInArchitectureIgnoring(DescribedPredicate)

ensureAllClassesAreContainedInArchitectureIgnoring

@PublicAPI(usage=ACCESS)
public Architectures.LayeredArchitecture ensureAllClassesAreContainedInArchitectureIgnoring(DescribedPredicate<? super JavaClass> predicate)

Like ensureAllClassesAreContainedInArchitecture() but will ignore classes in packages matching the specified predicate.

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 JavaClass can be found within JavaClass.Predicates or one of the respective ancestors like HasName.Predicates.

Parameters:

predicate - predicate specifying which classes may live outside the architecture

See Also:

• ensureAllClassesAreContainedInArchitecture()
• ensureAllClassesAreContainedInArchitectureIgnoring(String...)

check

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

Specified by:

check in interface ArchRule

because

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

Specified by:

because in interface ArchRule

allowEmptyShould

public ArchRule allowEmptyShould(boolean allowEmptyShould)

This method is equivalent to calling withOptionalLayers(boolean), which should be preferred in this context as the meaning is easier to understand.

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

as

@PublicAPI(usage=ACCESS)
public Architectures.LayeredArchitecture 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 Architectures.LayeredArchitecture ignoreDependency(Class<?> origin,
 Class<?> target)

Configures the rule to ignore any violation from a specific origin class to a specific target class.

Parameters:

origin - A Class object specifying the origin of a Dependency to ignore

target - A Class object specifying the target of a Dependency to ignore

Returns:

a Architectures.LayeredArchitecture to be used as an ArchRule or further restricted through a fluent API.

ignoreDependency

@PublicAPI(usage=ACCESS)
public Architectures.LayeredArchitecture ignoreDependency(String originFullyQualifiedClassName,
 String targetFullyQualifiedClassName)

Same as ignoreDependency(Class, Class) but allows specifying origin and target as fully qualified class names.

ignoreDependency

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

Same as ignoreDependency(Class, Class) but allows specifying origin and target by freely defined predicates. Any dependency where the Dependency.getOriginClass() matches the origin predicate and the Dependency.getTargetClass() matches the target predicate will be ignored.

whereLayer

@PublicAPI(usage=ACCESS)
public Architectures.LayeredArchitecture.LayerDependencySpecification whereLayer(String name)

Allows restricting accesses to or from this layer. Note that "access" in the context of a layer refers to any dependency as defined by Dependency.

Parameters:

name - a layer name as specified before via layer(String)

Returns:

a specification to fluently define further restrictions