com.tngtech.archunit.library.dependencies

Class Slices

java.lang.Object

com.tngtech.archunit.library.dependencies.Slices

All Implemented Interfaces:

DescribedIterable<Slice>, HasDescription, java.lang.Iterable<Slice>

public final class Slices
extends java.lang.Object
implements DescribedIterable<Slice>

Basic collection of Slice for tests on dependencies of package slices, e.g. to avoid cycles. Example to specify a ClassesTransformer to run ArchRules against Slices:

 Slices.matching("some.pkg.(*)..")
 

would group the packages

• some.pkg.one.any
• some.pkg.one.other

in the same slice, the package

• some.pkg.two.any

in a different slice.
The resulting ClassesTransformer can be used to specify an ArchRule on slices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Slices.Creator
static class	Slices.Transformer Specifies how to transform a set of JavaClass into a set of Slice, e.g.

Nested classes/interfaces inherited from interface com.tngtech.archunit.base.DescribedIterable

DescribedIterable.From

Method Summary

Methods

Modifier and Type	Method and Description
Slices	as(java.lang.String description)
java.lang.String	getDescription()
java.util.Iterator<Slice>	iterator()
static Slices.Transformer	matching(java.lang.String packageIdentifier)
Slices	namingSlices(java.lang.String pattern) Allows the naming of single slices, where back references to the matching pattern can be denoted by '$' followed by capturing group number.

Methods inherited from class java.lang.Object

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

Method Detail

iterator

public java.util.Iterator<Slice> iterator()

Specified by:

iterator in interface java.lang.Iterable<Slice>

as

public Slices as(java.lang.String description)

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface HasDescription

namingSlices

public Slices namingSlices(java.lang.String pattern)

Allows the naming of single slices, where back references to the matching pattern can be denoted by '$' followed by capturing group number.
E.g. namingSlices("Slice $1") would name a slice matching '*..service.(*)..*' against 'com.some.company.service.hello.something' as 'Slice hello'.

Parameters:

pattern - The naming pattern, e.g. 'Slice $1'

Returns:

The same slices with adjusted naming for each single slice

matching

public static Slices.Transformer matching(java.lang.String packageIdentifier)

See Also:

Slices.Creator.matching(String)