Package com.tngtech.archunit.core.domain

Class JavaAccess<TARGET extends AccessTarget>

java.lang.Object

com.tngtech.archunit.core.domain.JavaAccess<TARGET>

All Implemented Interfaces:

HasDescription, Convertible, HasName, HasOwner<JavaCodeUnit>, HasSourceCodeLocation

Direct Known Subclasses:

JavaCodeUnitAccess, JavaFieldAccess

@PublicAPI(usage=ACCESS)
public abstract class JavaAccess<TARGET extends AccessTarget>
extends Object
implements HasName, HasDescription, HasOwner<JavaCodeUnit>, HasSourceCodeLocation, Convertible

Nested Class Summary

Nested Classes

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

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

HasName.AndFullName, HasName.Utils

Method Summary

Modifier and Type	Method	Description
<T> Set<T>	convertTo(Class<T> type)	Converts this type to a set of other types.
protected abstract String	descriptionVerb()
Set<TryCatchBlock>	getContainingTryBlocks()
String	getDescription()
int	getLineNumber()
String	getName()
JavaCodeUnit	getOrigin()
JavaClass	getOriginOwner()
JavaCodeUnit	getOwner()
SourceCodeLocation	getSourceCodeLocation()
TARGET	getTarget()
JavaClass	getTargetOwner()
boolean	isDeclaredInLambda()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getName

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

Specified by:

getName in interface HasName

getOrigin

@PublicAPI(usage=ACCESS)
public JavaCodeUnit getOrigin()

getOriginOwner

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

getTargetOwner

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

getTarget

@PublicAPI(usage=ACCESS)
public TARGET getTarget()

getLineNumber

@PublicAPI(usage=ACCESS)
public int getLineNumber()

getOwner

@PublicAPI(usage=ACCESS)
public JavaCodeUnit getOwner()

Specified by:

getOwner in interface HasOwner<TARGET extends AccessTarget>

Returns:

The "owner" of this object, compare HasOwner

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.

isDeclaredInLambda

@PublicAPI(usage=ACCESS)
public boolean isDeclaredInLambda()

convertTo

public <T> Set<T> convertTo(Class<T> type)

Description copied from interface: Convertible

Converts this type to a set of other types. For example a JavaAccess can also be considered a Dependency, so javaAccess.convertTo(Dependency.class) will yield a set with a single Dependency representing this access. Or a component dependency grouping many class dependencies could be considered a set of exactly these class dependencies. The result will be an empty set if no conversion is possible (e.g. calling javaAccess.convertTo(Integer.class).

Specified by:

convertTo in interface Convertible

Parameters:

type - The type to convert to

Returns:

A set of converted elements, empty if no conversion is possible

toString

public String toString()

Overrides:

toString in class Object

getDescription

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

Specified by:

getDescription in interface HasDescription

descriptionVerb

protected abstract String descriptionVerb()

getContainingTryBlocks

@PublicAPI(usage=ACCESS)
public Set<TryCatchBlock> getContainingTryBlocks()

Returns:

All try-catch-blocks where this JavaAccess is contained within the try-part the try-catch-block