Package com.tngtech.archunit.library.modules

Class ArchModules.Creator

java.lang.Object

com.tngtech.archunit.library.modules.ArchModules.Creator

Direct Known Subclasses:

ArchModules.CreatorByRootClass

Enclosing class:

ArchModules<DESCRIPTOR extends ArchModule.Descriptor>

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public static class ArchModules.Creator
extends Object

An element of the fluent API to create ArchModules

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ArchModules.Creator.WithGenericDescriptor<DESCRIPTOR extends ArchModule.Descriptor>	An element of the fluent API to create ArchModules

Method Summary

Modifier and Type	Method	Description
ArchModules.Creator	deriveNameFromPattern(String namingPattern)	Allows to customize each ArchModule name by specifying a string pattern that defines how to derive the name from the ArchModule.Identifier. In particular, the passed namingPattern may contain numbered placeholders like ${1} to refer to parts from the ArchModule.Identifier.
<D extends ArchModule.Descriptor> ArchModules.Creator.WithGenericDescriptor<D>	describeBy(ArchModules.DescriptorCreator<D> descriptorCreator)	Allows to fully customize the ArchModule.Descriptor of the created ArchModules.
ArchModules<?>	modularize(JavaClasses classes)

Methods inherited from class java.lang.Object

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

Method Details

deriveNameFromPattern

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public ArchModules.Creator deriveNameFromPattern(String namingPattern)

Allows to customize each ArchModule name by specifying a string pattern that defines how to derive the name from the ArchModule.Identifier.
In particular, the passed namingPattern may contain numbered placeholders like ${1} to refer to parts from the ArchModule.Identifier. It may also contain the special placeholder $@ to refer to the colon-joined form of the identifier.
Suppose the ArchModule.Identifier is ["customer", "creation"], then the name could be derived as

 "Module[${1}/${2}]" -> would yield the name "Module[customer/creation]"
 "Module[$@]         -> would yield the name "Module[customer:creation]"
 

Note that the derived name must be unique between all modules.

Parameters:

namingPattern - A string naming pattern deriving the ArchModule name from the ArchModule.Identifier

Returns:

A fluent API to further customize how to create ArchModules

describeBy

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public <D extends ArchModule.Descriptor>
ArchModules.Creator.WithGenericDescriptor<D> describeBy(ArchModules.DescriptorCreator<D> descriptorCreator)

Allows to fully customize the ArchModule.Descriptor of the created ArchModules. This allows to pass on meta-data from the contained classes additionally to any derived module name.

Type Parameters:

D - The specific subtype of the ArchModule.Descriptor to create

Parameters:

descriptorCreator - A generic function specifying how to create the ArchModule.Descriptor

Returns:

A fluent API to further customize how to create ArchModules

modularize

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public ArchModules<?> modularize(JavaClasses classes)

See Also:

• ArchModules.Creator.WithGenericDescriptor.modularize(JavaClasses)