Package com.tngtech.archunit.library

Class Architectures.OnionArchitecture

java.lang.Object

com.tngtech.archunit.library.Architectures.OnionArchitecture

All Implemented Interfaces:

HasDescription, CanOverrideDescription<ArchRule>, ArchRule, CanBeEvaluated

Enclosing class:

Architectures

@PublicAPI(usage=ACCESS)
public static final class Architectures.OnionArchitecture
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
Architectures.OnionArchitecture	adapter(String name, DescribedPredicate<? super JavaClass> predicate)	Defines which classes belong to a specific adapter by matching them against the supplied predicate.
Architectures.OnionArchitecture	adapter(String name, String... packageIdentifiers)	Defines which classes belong to a specific adapter by matching them against package identifiers.
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.OnionArchitecture	applicationServices(DescribedPredicate<? super JavaClass> predicate)	Defines which classes belong to application services by matching them against the supplied predicate.
Architectures.OnionArchitecture	applicationServices(String... packageIdentifiers)	Defines which classes belong to application services by matching them against package identifiers.
Architectures.OnionArchitecture	as(String newDescription)	Allows to adjust the description of this object.
ArchRule	because(String reason)
void	check(JavaClasses classes)
Architectures.OnionArchitecture	domainModels(DescribedPredicate<? super JavaClass> predicate)	Defines which classes belong to domain models by matching them against the supplied predicate.
Architectures.OnionArchitecture	domainModels(String... packageIdentifiers)	Defines which classes belong to domain models by matching them against package identifiers.
Architectures.OnionArchitecture	domainServices(DescribedPredicate<? super JavaClass> predicate)	Defines which classes belong to domain services by matching them against the supplied predicate.
Architectures.OnionArchitecture	domainServices(String... packageIdentifiers)	Defines which classes belong to domain services by matching them against package identifiers.
Architectures.OnionArchitecture	ensureAllClassesAreContainedInArchitecture()	Ensure that all classes under test are contained within a defined onion architecture component.
Architectures.OnionArchitecture	ensureAllClassesAreContainedInArchitectureIgnoring(DescribedPredicate<? super JavaClass> predicate)	Like ensureAllClassesAreContainedInArchitecture() but will ignore classes in packages matching the specified predicate.
Architectures.OnionArchitecture	ensureAllClassesAreContainedInArchitectureIgnoring(String... packageIdentifiers)	Like ensureAllClassesAreContainedInArchitecture() but will ignore classes in packages matching the specified packageIdentifiers.
EvaluationResult	evaluate(JavaClasses classes)
String	getDescription()
Architectures.OnionArchitecture	ignoreDependency(DescribedPredicate<? super JavaClass> origin, DescribedPredicate<? super JavaClass> target)	Ignores all dependencies that have an origin class matching the supplied origin predicate and target class matching the supplied target predicate.
Architectures.OnionArchitecture	ignoreDependency(Class<?> origin, Class<?> target)	Ignores all dependencies that have an origin class equivalent to the supplied origin and target class equivalent to the supplied target.
Architectures.OnionArchitecture	ignoreDependency(String origin, String target)	Ignores all dependencies that have an origin class with fully qualified class name origin and target class with fully qualified class name target.
String	toString()
Architectures.OnionArchitecture	withOptionalLayers(boolean optionalLayers)

Methods inherited from class java.lang.Object

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

Method Details

domainModels

@PublicAPI(usage=ACCESS)
public Architectures.OnionArchitecture domainModels(String... packageIdentifiers)

Defines which classes belong to domain models by matching them against package identifiers.

Parameters:

packageIdentifiers - package identifiers defining which classes belong to domain models

Returns:

The Architectures.OnionArchitecture to be checked against classes or further customized

domainModels

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

Defines which classes belong to domain models by matching them against the supplied 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 - A DescribedPredicate defining which classes belong to domain models

Returns:

The Architectures.OnionArchitecture to be checked against classes or further customized

domainServices

@PublicAPI(usage=ACCESS)
public Architectures.OnionArchitecture domainServices(String... packageIdentifiers)

Defines which classes belong to domain services by matching them against package identifiers.

Parameters:

packageIdentifiers - package identifiers defining which classes belong to domain services

Returns:

The Architectures.OnionArchitecture to be checked against classes or further customized

domainServices

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

Defines which classes belong to domain services by matching them against the supplied 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 - A DescribedPredicate defining which classes belong to domain services

Returns:

The Architectures.OnionArchitecture to be checked against classes or further customized

applicationServices

@PublicAPI(usage=ACCESS)
public Architectures.OnionArchitecture applicationServices(String... packageIdentifiers)

Defines which classes belong to application services by matching them against package identifiers.

Parameters:

packageIdentifiers - package identifiers defining which classes belong to application services

Returns:

The Architectures.OnionArchitecture to be checked against classes or further customized

applicationServices

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

Defines which classes belong to application services by matching them against the supplied 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 - A DescribedPredicate defining which classes belong to application services

Returns:

The Architectures.OnionArchitecture to be checked against classes or further customized

adapter

@PublicAPI(usage=ACCESS)
public Architectures.OnionArchitecture adapter(String name,
 String... packageIdentifiers)

Defines which classes belong to a specific adapter by matching them against package identifiers.

Parameters:

name - The name of the adapter

packageIdentifiers - package identifiers defining which classes belong to the adapter

Returns:

The Architectures.OnionArchitecture to be checked against classes or further customized

adapter

@PublicAPI(usage=ACCESS)
public Architectures.OnionArchitecture adapter(String name,
 DescribedPredicate<? super JavaClass> predicate)

Defines which classes belong to a specific adapter by matching them against the supplied 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:

name - The name of the adapter

predicate - A DescribedPredicate defining which classes belong to the adapter

Returns:

The Architectures.OnionArchitecture to be checked against classes or further customized

withOptionalLayers

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

Parameters:

optionalLayers - Whether the different parts of the Onion Architecture (domain models, domain services, ...) should be allowed to be empty. If set to false the OnionArchitecture will fail if any such layer does not contain any class.

ignoreDependency

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

Ignores all dependencies that have an origin class equivalent to the supplied origin and target class equivalent to the supplied target.

ignoreDependency

@PublicAPI(usage=ACCESS)
public Architectures.OnionArchitecture ignoreDependency(String origin,
 String target)

Ignores all dependencies that have an origin class with fully qualified class name origin and target class with fully qualified class name target.

ignoreDependency

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

Ignores all dependencies that have an origin class matching the supplied origin predicate and target class matching the supplied target 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.

ensureAllClassesAreContainedInArchitecture

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

Ensure that all classes under test are contained within a defined onion architecture component.

See Also:

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

ensureAllClassesAreContainedInArchitectureIgnoring

@PublicAPI(usage=ACCESS)
public Architectures.OnionArchitecture 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.OnionArchitecture 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

public void check(JavaClasses classes)

Specified by:

check in interface ArchRule

because

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

public Architectures.OnionArchitecture 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

evaluate

public EvaluationResult evaluate(JavaClasses classes)

Specified by:

evaluate in interface CanBeEvaluated

getDescription

public String getDescription()

Specified by:

getDescription in interface HasDescription

toString

public String toString()

Overrides:

toString in class Object