Package com.tngtech.archunit.library.metrics

Class MetricsComponents<T>

java.lang.Object

com.tngtech.archunit.base.ForwardingCollection<MetricsComponent<T>>

com.tngtech.archunit.library.metrics.MetricsComponents<T>

All Implemented Interfaces:

Iterable<MetricsComponent<T>>, Collection<MetricsComponent<T>>

@PublicAPI(usage=ACCESS)
public final class MetricsComponents<T>
extends ForwardingCollection<MetricsComponent<T>>

A collection of MetricsComponent. Provides factory methods create components from ArchUnit domain objects like JavaPackage or to componentize sets of elements.

See Also:

• of(Collection)
• from(Collection, Function)
• fromPackages(Collection)
• fromClasses(Collection)

Method Summary

Modifier and Type	Method	Description
protected Collection<MetricsComponent<T>>	delegate()
static <T> MetricsComponents<T>	from(Collection<T> elements, Function<? super T,String> identifierFunction)	Partitions the passed set of elements into components according to the specified identifierFunction.
static MetricsComponents<JavaClass>	fromClasses(Collection<JavaClass> classes)	Creates one MetricsComponent for each passed JavaClass containing only this class itself.
static MetricsComponents<JavaClass>	fromPackages(Collection<JavaPackage> packages)	Creates one MetricsComponent for each passed JavaPackage containing all classes contained in the respective package or any subpackage.
static <T> MetricsComponents<T>	of(MetricsComponent<T>... components)
static <T> MetricsComponents<T>	of(Collection<MetricsComponent<T>> metricsComponents)	Creates MetricsComponents containing the supplied collection of MetricsComponent. Note that the identifiers of the passed components must all be unique.
Optional<MetricsComponent<T>>	tryGetComponent(String identifier)

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Method Details

tryGetComponent

@PublicAPI(usage=ACCESS)
public Optional<MetricsComponent<T>> tryGetComponent(String identifier)

Parameters:

identifier - The identifier of a component

Returns:

The component with the specified identifier if present, Optional.absent() otherwise.

delegate

protected Collection<MetricsComponent<T>> delegate()

Specified by:

delegate in class ForwardingCollection<MetricsComponent<T>>

of

@SafeVarargs
@PublicAPI(usage=ACCESS)
public static <T> MetricsComponents<T> of(MetricsComponent<T>... components)

See Also:

• of(Collection)

of

@PublicAPI(usage=ACCESS)
public static <T> MetricsComponents<T> of(Collection<MetricsComponent<T>> metricsComponents)

Creates MetricsComponents containing the supplied collection of MetricsComponent.
Note that the identifiers of the passed components must all be unique.

Type Parameters:

T - The type of the elements contained within each component

Parameters:

metricsComponents - The components the result will contain

Returns:

The created MetricsComponents

Throws:

IllegalArgumentException - if any two components have a duplicate identifier

from

@PublicAPI(usage=ACCESS)
public static <T> MetricsComponents<T> from(Collection<T> elements,
 Function<? super T,String> identifierFunction)

Partitions the passed set of elements into components according to the specified identifierFunction. That is for each element of elements the respective component identifier will be derived via the passed identifierFunction. For each such identifier a component will be created and all elements with the same identifier will end up in the same component.

Type Parameters:

T - The type of the elements

Parameters:

elements - The elements to componentize

identifierFunction - A function to create the respective identifier each element belongs to

Returns:

MetricsComponents containing one component for each unique identifier created this way

fromPackages

@PublicAPI(usage=ACCESS)
public static MetricsComponents<JavaClass> fromPackages(Collection<JavaPackage> packages)

Creates one MetricsComponent for each passed JavaPackage containing all classes contained in the respective package or any subpackage. The identifier for each component will be the full package name of the respective JavaPackage.

Parameters:

packages - A collection of packages to derive the components from

Returns:

MetricsComponents where components mirror the passed packages

fromClasses

@PublicAPI(usage=ACCESS)
public static MetricsComponents<JavaClass> fromClasses(Collection<JavaClass> classes)

Creates one MetricsComponent for each passed JavaClass containing only this class itself. The identifier for each component will be the fully qualified class name of the contained JavaClass.

Parameters:

classes - The classes to created components from

Returns:

MetricsComponents where components mirror the passed classes one to one