Package com.tngtech.archunit.core.domain

Class AccessTarget.CodeUnitAccessTarget

java.lang.Object

com.tngtech.archunit.core.domain.AccessTarget

com.tngtech.archunit.core.domain.AccessTarget.CodeUnitAccessTarget

All Implemented Interfaces:

HasDescription, CanBeAnnotated, HasName, HasName.AndFullName, HasOwner<JavaClass>, HasParameterTypes, HasReturnType, HasThrowsClause<AccessTarget.CodeUnitAccessTarget>

Direct Known Subclasses:

AccessTarget.CodeUnitCallTarget, AccessTarget.CodeUnitReferenceTarget

Enclosing class:

AccessTarget

public abstract static class AccessTarget.CodeUnitAccessTarget
extends AccessTarget
implements HasParameterTypes, HasReturnType, HasThrowsClause<AccessTarget.CodeUnitAccessTarget>

Represents an AccessTarget where the target is a code unit. For further elaboration about the necessity to distinguish CodeUnitAccessTarget from JavaCodeUnit, refer to the documentation at AccessTarget.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AccessTarget.CodeUnitAccessTarget.Functions

Nested classes/interfaces inherited from class com.tngtech.archunit.core.domain.AccessTarget

AccessTarget.CodeUnitAccessTarget, AccessTarget.CodeUnitCallTarget, AccessTarget.CodeUnitReferenceTarget, AccessTarget.ConstructorCallTarget, AccessTarget.ConstructorReferenceTarget, AccessTarget.FieldAccessTarget, AccessTarget.MethodCallTarget, AccessTarget.MethodReferenceTarget, AccessTarget.Predicates

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

CanBeAnnotated.Utils

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

HasName.AndFullName, HasName.Utils

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

HasParameterTypes.Predicates

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

HasReturnType.Predicates

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

HasThrowsClause.Predicates

Method Summary

Modifier and Type	Method	Description
List<JavaType>	getParameterTypes()
List<JavaClass>	getRawParameterTypes()
JavaClass	getRawReturnType()
JavaType	getReturnType()
ThrowsClause<? extends AccessTarget.CodeUnitAccessTarget>	getThrowsClause()
abstract Set<? extends JavaCodeUnit>	resolve()	Deprecated. This will never return more than one element, use resolveMember() instead
Optional<? extends JavaCodeUnit>	resolveMember()	Tries to resolve the targeted method or constructor.

Methods inherited from class com.tngtech.archunit.core.domain.AccessTarget

equals, getFullName, getName, getOwner, hashCode, isAnnotatedWith, isAnnotatedWith, isAnnotatedWith, isMetaAnnotatedWith, isMetaAnnotatedWith, isMetaAnnotatedWith, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tngtech.archunit.base.HasDescription

getDescription

Method Details

getParameterTypes

public List<JavaType> getParameterTypes()

Specified by:

getParameterTypes in interface HasParameterTypes

Returns:

the raw parameter types of this object, e.g.
for a method

void someMethod(String first, int second) {..}

this would be the JavaClasses equivalent to [String.class, int.class],
for a method

<T> void someMethod(T generic) {..}

this would be the JavaTypeVariable T.
Note that for non-generic cases this returns the same as HasParameterTypes.getRawParameterTypes().

getRawParameterTypes

@PublicAPI(usage=ACCESS)
public List<JavaClass> getRawParameterTypes()

Specified by:

getRawParameterTypes in interface HasParameterTypes

Returns:

the raw parameter types of this object, e.g.
for a method

void someMethod(String first, int second) {..}

this would be the JavaClasses equivalent to [String.class, int.class],
for a method

<T> void someMethod(T generic) {..}

this would be the erasure of the generic type variable T, i.e. the JavaClass equivalent to Object.class.
Note that for non-generic cases this returns the same as HasParameterTypes.getParameterTypes().

getReturnType

@PublicAPI(usage=ACCESS)
public JavaType getReturnType()

Specified by:

getReturnType in interface HasReturnType

getRawReturnType

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

Specified by:

getRawReturnType in interface HasReturnType

getThrowsClause

@PublicAPI(usage=ACCESS)
public ThrowsClause<? extends AccessTarget.CodeUnitAccessTarget> getThrowsClause()

Specified by:

getThrowsClause in interface HasThrowsClause<AccessTarget.CodeUnitAccessTarget>

resolveMember

@PublicAPI(usage=ACCESS)
public Optional<? extends JavaCodeUnit> resolveMember()

Tries to resolve the targeted method or constructor.

Overrides:

resolveMember in class AccessTarget

Returns:

The member that matches the access target or empty if it was not imported

See Also:

• AccessTarget.ConstructorCallTarget.resolveMember()
• AccessTarget.MethodCallTarget.resolveMember()

resolve

@Deprecated
@PublicAPI(usage=ACCESS)
public abstract Set<? extends JavaCodeUnit> resolve()

Deprecated.

This will never return more than one element, use resolveMember() instead

Specified by:

resolve in class AccessTarget