Package com.tngtech.archunit.library.modules

Class ArchModule.Identifier

java.lang.Object

com.tngtech.archunit.library.modules.ArchModule.Identifier

All Implemented Interfaces:

Iterable<String>

Enclosing class:

ArchModule<DESCRIPTOR extends ArchModule.Descriptor>

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public static final class ArchModule.Identifier
extends Object
implements Iterable<String>

An ArchModule.Identifier of an ArchModule. An ArchModule.Identifier is basically an ordered list of string parts that uniquely identifies an ArchModule, i.e. two modules are equal, if and only if their identifier is equal (i.e. all the textual parts of the identifier match in order).

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static ArchModule.Identifier	from(String... parts)
static ArchModule.Identifier	from(List<String> parts)
int	getNumberOfParts()
String	getPart(int index)
int	hashCode()
static ArchModule.Identifier	ignore()	Factory method to signal that this ArchModule is irrelevant.
Iterator<String>	iterator()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

from

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public static ArchModule.Identifier from(String... parts)

See Also:

• from(List)

from

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public static ArchModule.Identifier from(List<String> parts)

Parameters:

parts - The textual parts of the ArchModule.Identifier, must not be empty

Returns:

An ArchModule.Identifier consisting of the passed parts

ignore

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

Factory method to signal that this ArchModule is irrelevant. The ArchModule identified by this ArchModule.Identifier will e.g. be omitted when creating ArchModules and should i.g. be completely ignored for all purposes.

Returns:

An ArchModule.Identifier that signals that this ArchModule is irrelevant and should be ignored.

getNumberOfParts

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public int getNumberOfParts()

Returns:

The number of (textual) parts this identifier consists of.

getPart

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public String getPart(int index)

Parameters:

index - Index of the requested (textual) part

Returns:

Part with the given index; indices are 1-based (i.e. getPart(1)) returns the first part.

iterator

@PublicAPI(usage=ACCESS,
           state=EXPERIMENTAL)
public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object