Package com.tngtech.archunit.core.domain

Class Dependency

java.lang.Object

com.tngtech.archunit.core.domain.Dependency

All Implemented Interfaces:

HasDescription, HasSourceCodeLocation, Comparable<Dependency>

@PublicAPI(usage=ACCESS)
public final class Dependency
extends Object
implements HasDescription, Comparable<Dependency>, HasSourceCodeLocation

Represents a dependency of one Java class on another Java class. Such a dependency can occur by either of the following:

• a class accesses a field of another class
• a class calls a method/constructor of another class
• a class inherits from another class
• a class implements an interface
• a class has a field with type of another class
• a class has a method/constructor with parameter/return type of another class
• a class (or method/constructor of this class) declares a type parameter referencing another class
• a class (or method/constructor of this class) is annotated with an annotation of a certain type or referencing another class as annotation parameter
• a method/constructor of a class references another class in a throws declaration
• a class references another class object (e.g. Example.class)
• a class references another class in an instanceof check

Note that a Dependency will by definition never be a self-reference, i.e. origin will never be equal to target.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Dependency.Functions	Predefined functions to transform Dependency.
static final class	Dependency.Predicates	Predefined predicates targeting Dependency.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Dependency o)
boolean	equals(Object obj)
String	getDescription()
JavaClass	getOriginClass()
SourceCodeLocation	getSourceCodeLocation()
JavaClass	getTargetClass()
int	hashCode()
String	toString()
static JavaClasses	toTargetClasses(Iterable<Dependency> dependencies)

Methods inherited from class java.lang.Object

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

Method Details

getOriginClass

@PublicAPI(usage=ACCESS)
public JavaClass getOriginClass()

Returns:

The class where this dependency originates from (e.g. because the origin class calls a method of another class)

getTargetClass

@PublicAPI(usage=ACCESS)
public JavaClass getTargetClass()

Returns:

The class that is targeted by this dependency (e.g. because it contains a method that is called from another class)

getDescription

@PublicAPI(usage=ACCESS)
public String getDescription()

Specified by:

getDescription in interface HasDescription

getSourceCodeLocation

@PublicAPI(usage=ACCESS)
public SourceCodeLocation getSourceCodeLocation()

Specified by:

getSourceCodeLocation in interface HasSourceCodeLocation

Returns:

The SourceCodeLocation of this object, i.e. how to locate the respective object within the set of source files.

compareTo

@PublicAPI(usage=ACCESS)
public int compareTo(Dependency o)

Specified by:

compareTo in interface Comparable<Dependency>

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

toTargetClasses

@PublicAPI(usage=ACCESS)
public static JavaClasses toTargetClasses(Iterable<Dependency> dependencies)