Package com.tngtech.archunit.library.modules

Class ArchModule<DESCRIPTOR extends ArchModule.Descriptor>

java.lang.Object

com.tngtech.archunit.base.ForwardingCollection<JavaClass>

com.tngtech.archunit.base.ForwardingSet<JavaClass>

com.tngtech.archunit.library.modules.ArchModule<DESCRIPTOR>

All Implemented Interfaces:

HasName, Iterable<JavaClass>, Collection<JavaClass>, Set<JavaClass>

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public final class ArchModule<DESCRIPTOR extends ArchModule.Descriptor>
extends ForwardingSet<JavaClass>
implements HasName

Represents a generic "architecture module", i.e. any group of classes that should form a cohesive unit.
An ArchModule can be identified by its identifier. Vice versa an ArchModule can be defined as a mapping JavaClass -> ArchModule.Identifier, where all classes that are mapped to the same identifier will end up in the same module.
ArchModule offers an API to obtain all class dependencies, i.e. all dependencies from classes within the module to classes outside of the module. It also offers an API to obtain all module dependencies, i.e. dependencies from this ArchModule to another ArchModule where these dependencies reflect all class dependencies where the origin resides within this ArchModule and the target resides within another ArchModule.

To create ArchModules please refer to ArchModules.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ArchModule.Descriptor	Contains meta-information for an ArchModule.
static final class	ArchModule.Identifier	An ArchModule.Identifier of an ArchModule.

Nested classes/interfaces inherited from interface com.tngtech.archunit.core.domain.properties.HasName

HasName.AndFullName, HasName.Functions, HasName.Predicates, HasName.Utils

Method Summary

Modifier and Type	Method	Description
protected Set<JavaClass>	delegate()
boolean	equals(Object obj)
Set<Dependency>	getClassDependenciesFromSelf()
Set<Dependency>	getClassDependenciesToSelf()
DESCRIPTOR	getDescriptor()
ArchModule.Identifier	getIdentifier()
Set<ModuleDependency<DESCRIPTOR>>	getModuleDependenciesFromSelf()
Set<ModuleDependency<DESCRIPTOR>>	getModuleDependenciesToSelf()
String	getName()
Set<Dependency>	getUndefinedDependencies()
int	hashCode()
String	toString()

Methods inherited from class com.tngtech.archunit.base.ForwardingCollection

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Method Details

delegate

protected Set<JavaClass> delegate()

Specified by:

delegate in class ForwardingSet<JavaClass>

getIdentifier

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public ArchModule.Identifier getIdentifier()

Returns:

The ArchModule.Identifier of this module

getName

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public String getName()

Specified by:

getName in interface HasName

Returns:

The name of this module, i.e. a human-readable string representing this module

getDescriptor

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public DESCRIPTOR getDescriptor()

Returns:

The ArchModule.Descriptor of this ArchModule

getClassDependenciesFromSelf

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public Set<Dependency> getClassDependenciesFromSelf()

Returns:

All dependencies where the origin class is contained within this ArchModule.

getClassDependenciesToSelf

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public Set<Dependency> getClassDependenciesToSelf()

Returns:

All dependencies where the target class is contained within this ArchModule.

getModuleDependenciesFromSelf

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public Set<ModuleDependency<DESCRIPTOR>> getModuleDependenciesFromSelf()

Returns:

All module dependencies where the origin equals this ArchModule.

getModuleDependenciesToSelf

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public Set<ModuleDependency<DESCRIPTOR>> getModuleDependenciesToSelf()

Returns:

All module dependencies where the target equals this ArchModule.

getUndefinedDependencies

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public Set<Dependency> getUndefinedDependencies()

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<DESCRIPTOR extends ArchModule.Descriptor>

Specified by:

hashCode in interface Set<DESCRIPTOR extends ArchModule.Descriptor>

Overrides:

hashCode in class ForwardingCollection<JavaClass>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<DESCRIPTOR extends ArchModule.Descriptor>

Specified by:

equals in interface Set<DESCRIPTOR extends ArchModule.Descriptor>

Overrides:

equals in class ForwardingCollection<JavaClass>

toString

public String toString()

Overrides:

toString in class ForwardingCollection<JavaClass>