Package com.tngtech.archunit.library.metrics

Class ArchitectureMetrics

java.lang.Object

com.tngtech.archunit.library.metrics.ArchitectureMetrics

@PublicAPI(usage=ACCESS)
public final class ArchitectureMetrics
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
static ComponentDependencyMetrics	componentDependencyMetrics(MetricsComponents<JavaClass> components)	Calculates system component dependency metrics as defined by Robert C.
static LakosMetrics	lakosMetrics(MetricsComponents<JavaClass> components)	Calculates system architecture metrics as defined by John Lakos.
static <T> LakosMetrics	lakosMetrics(MetricsComponents<T> components, Function<T,java.util.Collection<T>> getDependencies)	Calculates system architecture metrics as defined by John Lakos.
static VisibilityMetrics	visibilityMetrics(MetricsComponents<JavaClass> components)	Calculates system component visibility metrics as defined by Herbert Dowalil.
static <T> VisibilityMetrics	visibilityMetrics(MetricsComponents<T> components, Predicate<? super T> isVisible)	Calculates system component visibility metrics as defined by Herbert Dowalil.

Methods inherited from class java.lang.Object

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

Method Details

lakosMetrics

@PublicAPI(usage=ACCESS)
public static LakosMetrics lakosMetrics(MetricsComponents<JavaClass> components)

Calculates system architecture metrics as defined by John Lakos. This method is a specific version of lakosMetrics(MetricsComponents, Function) for JavaClasses.

Parameters:

components - The components to calculate the metrics for

Returns:

The calculated LakosMetrics

lakosMetrics

@PublicAPI(usage=ACCESS)
public static <T> LakosMetrics lakosMetrics(MetricsComponents<T> components,
Function<T,java.util.Collection<T>> getDependencies)

Calculates system architecture metrics as defined by John Lakos.

Type Parameters:

T - The type of the elements

Parameters:

components - The components to calculate the metrics for

getDependencies - A function to derive for each element of a component the dependencies to all other elements

Returns:

The calculated LakosMetrics

componentDependencyMetrics

@PublicAPI(usage=ACCESS)
public static ComponentDependencyMetrics componentDependencyMetrics(MetricsComponents<JavaClass> components)

Calculates system component dependency metrics as defined by Robert C. Martin.

Parameters:

components - The components to calculate the metrics for

Returns:

The calculated ComponentDependencyMetrics

visibilityMetrics

@PublicAPI(usage=ACCESS)
public static VisibilityMetrics visibilityMetrics(MetricsComponents<JavaClass> components)

Calculates system component visibility metrics as defined by Herbert Dowalil. This method is a specific version of visibilityMetrics(MetricsComponents, Predicate) where the elements can only be of type JavaClass and a class is considered visible, if and only if it is public.

Parameters:

components - The components to calculate the metrics for

Returns:

The calculated VisibilityMetrics

visibilityMetrics

@PublicAPI(usage=ACCESS)
public static <T> VisibilityMetrics visibilityMetrics(MetricsComponents<T> components,
Predicate<? super T> isVisible)

Calculates system component visibility metrics as defined by Herbert Dowalil.

Parameters:

components - The components to calculate the metrics for

Returns:

The calculated VisibilityMetrics