Package com.tngtech.archunit.library.modules

Interface ArchModule.Descriptor

All Known Implementing Classes:

AnnotationDescriptor

Enclosing class:

ArchModule<DESCRIPTOR extends ArchModule.Descriptor>

@PublicAPI(usage=INHERITANCE)
public static interface ArchModule.Descriptor

Contains meta-information for an ArchModule. By default, this meta-information only contains the module name, but it can be freely extended by users to transport more meta-information (e.g. allowed dependencies) when modularizing JavaClasses into ArchModules.

Method Summary

Modifier and Type	Method	Description
static ArchModule.Descriptor	create(String name)	Creates a default ArchModule.Descriptor only containing the passed name as getName().
String	getName()

Method Details

getName

String getName()

Returns:

The name of the respective ArchModule described by this ArchModule.Descriptor

create

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
static ArchModule.Descriptor create(String name)

Creates a default ArchModule.Descriptor only containing the passed name as getName().

Parameters:

name - The name of the described ArchModule

Returns:

A ArchModule.Descriptor carrying the passed name