Package com.tngtech.archunit.core.domain

Class JavaCodeUnit

java.lang.Object

com.tngtech.archunit.core.domain.JavaMember

com.tngtech.archunit.core.domain.JavaCodeUnit

All Implemented Interfaces:

HasDescription, CanBeAnnotated, HasAnnotations<JavaMember>, HasDescriptor, HasModifiers, HasName, HasName.AndFullName, HasOwner<JavaClass>, HasParameterTypes, HasReturnType, HasSourceCodeLocation, HasThrowsClause<JavaCodeUnit>, HasTypeParameters<JavaCodeUnit>

Direct Known Subclasses:

JavaConstructor, JavaMethod, JavaStaticInitializer

@PublicAPI(usage=ACCESS)
public abstract class JavaCodeUnit
extends JavaMember
implements HasParameterTypes, HasReturnType, HasTypeParameters<JavaCodeUnit>, HasThrowsClause<JavaCodeUnit>

Represents a unit of code containing accesses to other units of code. A unit of code can be

• a method
• a constructor
• a static initializer

in particular every place, where Java code with behavior, like calling other methods or accessing fields, can be defined.

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
Set<JavaAccess<?>>	getAccessesFromSelf()
JavaAnnotation<? extends JavaCodeUnit>	getAnnotationOfType(String typeName)
Set<? extends JavaAnnotation<? extends JavaCodeUnit>>	getAnnotations()
Set<JavaCall<?>>	getCallsFromSelf()
abstract Set<? extends JavaCall<?>>	getCallsOfSelf()
Set<JavaCodeUnitReference<?>>	getCodeUnitReferencesFromSelf()
Set<JavaConstructorCall>	getConstructorCallsFromSelf()
Set<JavaConstructorReference>	getConstructorReferencesFromSelf()
List<JavaClass>	getExceptionTypes()
Set<JavaFieldAccess>	getFieldAccesses()
String	getFullName()
Set<InstanceofCheck>	getInstanceofChecks()
Set<JavaMethodCall>	getMethodCallsFromSelf()
Set<JavaMethodReference>	getMethodReferencesFromSelf()
List<Set<JavaAnnotation<JavaParameter>>>	getParameterAnnotations()
List<JavaParameter>	getParameters()
List<JavaType>	getParameterTypes()
List<JavaClass>	getRawParameterTypes()
JavaClass	getRawReturnType()
Set<ReferencedClassObject>	getReferencedClassObjects()
JavaType	getReturnType()
abstract ThrowsClause<? extends JavaCodeUnit>	getThrowsClause()
Set<TryCatchBlock>	getTryCatchBlocks()
List<? extends JavaTypeVariable<? extends JavaCodeUnit>>	getTypeParameters()
boolean	isConstructor()
boolean	isMethod()
Optional<? extends JavaAnnotation<? extends JavaCodeUnit>>	tryGetAnnotationOfType(String typeName)

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

getAccessesToSelf, getAnnotationOfType, getDescriptor, getModifiers, getName, getOwner, getReverseDependencies, getSourceCodeLocation, isAnnotatedWith, isAnnotatedWith, isAnnotatedWith, isMetaAnnotatedWith, isMetaAnnotatedWith, isMetaAnnotatedWith, reflect, toString, tryGetAnnotationOfType

Methods inherited from class java.lang.Object

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

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

getDescription

Method Details

getFullName

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

Specified by:

getFullName in interface HasName.AndFullName

Returns:

The full name of this JavaCodeUnit, i.e. a string containing ${declaringClass}.${name}(${parameterTypes})

getRawParameterTypes

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

Specified by:

getRawParameterTypes in interface HasParameterTypes

Returns:

the raw parameter types of this JavaCodeUnit. On the contrary to getParameterTypes() these will always be JavaClass and thus not containing any parameterization/generic information. Note that the raw parameter types can contain synthetic parameters added by the compiler. E.g. for inner class constructors that receive the outer class as synthetic parameter or enum constructors that receive enum name and ordinal as synthetic parameters. There is no guarantee about the number of synthetic parameters, nor if they are appended or prepended, as e.g. local classes will append all local variables from the outer scope that are referenced as additional synthetic constructor parameters.

See Also:

• getParameterTypes()
• getParameters()

getParameterTypes

@PublicAPI(usage=ACCESS)
public List<JavaType> getParameterTypes()

Specified by:

getParameterTypes in interface HasParameterTypes

Returns:

the (possibly generic) parameter types of this JavaCodeUnit. This could for example be a JavaTypeVariable or a JavaParameterizedType, but also simply a JavaClass.
Note that if the method has a generic signature (e.g. declaring a parameterized type) then on the contrary to getRawParameterTypes() these types will be parsed from the signature encoded in the bytecode, i.e. they will not contain synthetic parameters added by the compiler. However, if there is no generic signature, then this information can also not be parsed from the signature. In this case the parameter types will be equal to the raw parameter types and by that can also contain synthetic parameters.

See Also:

• getRawParameterTypes()
• getParameters()

getParameters

@PublicAPI(usage=ACCESS)
public List<JavaParameter> getParameters()

Returns:

the parameters of this JavaCodeUnit. On the contrary to the Reflection API this will only contain the parameters from the signature and not synthetic parameters, if the signature is generic. In these cases getParameters().size() will always be equal to getParameterTypes().size(), but not necessarily to getRawParameterTypes().size() in case the compiler adds synthetic parameters.
Note that for non-generic method signatures getParameters() actually contains the raw parameter types and thus can also contain synthetic parameters. Unfortunately there is no way at the moment to distinguish synthetic parameters from non-synthetic parameters in these cases.

See Also:

• getRawParameterTypes()
• getParameterTypes()

getThrowsClause

@PublicAPI(usage=ACCESS)
public abstract ThrowsClause<? extends JavaCodeUnit> getThrowsClause()

Specified by:

getThrowsClause in interface HasThrowsClause<JavaCodeUnit>

getExceptionTypes

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

Returns:

The types thrown by this method, similar to Method.getExceptionTypes()

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

getFieldAccesses

@PublicAPI(usage=ACCESS)
public Set<JavaFieldAccess> getFieldAccesses()

getCallsOfSelf

@PublicAPI(usage=ACCESS)
public abstract Set<? extends JavaCall<?>> getCallsOfSelf()

getMethodCallsFromSelf

@PublicAPI(usage=ACCESS)
public Set<JavaMethodCall> getMethodCallsFromSelf()

getConstructorCallsFromSelf

@PublicAPI(usage=ACCESS)
public Set<JavaConstructorCall> getConstructorCallsFromSelf()

getMethodReferencesFromSelf

@PublicAPI(usage=ACCESS)
public Set<JavaMethodReference> getMethodReferencesFromSelf()

getConstructorReferencesFromSelf

@PublicAPI(usage=ACCESS)
public Set<JavaConstructorReference> getConstructorReferencesFromSelf()

getReferencedClassObjects

@PublicAPI(usage=ACCESS)
public Set<ReferencedClassObject> getReferencedClassObjects()

getInstanceofChecks

@PublicAPI(usage=ACCESS)
public Set<InstanceofCheck> getInstanceofChecks()

getTryCatchBlocks

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

getCallsFromSelf

@PublicAPI(usage=ACCESS)
public Set<JavaCall<?>> getCallsFromSelf()

getCodeUnitReferencesFromSelf

@PublicAPI(usage=ACCESS)
public Set<JavaCodeUnitReference<?>> getCodeUnitReferencesFromSelf()

getAccessesFromSelf

@PublicAPI(usage=ACCESS)
public Set<JavaAccess<?>> getAccessesFromSelf()

isConstructor

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

isMethod

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

getAnnotations

public Set<? extends JavaAnnotation<? extends JavaCodeUnit>> getAnnotations()

Specified by:

getAnnotations in interface HasAnnotations<JavaMember>

Overrides:

getAnnotations in class JavaMember

getAnnotationOfType

public JavaAnnotation<? extends JavaCodeUnit> getAnnotationOfType(String typeName)

Specified by:

getAnnotationOfType in interface HasAnnotations<JavaMember>

Overrides:

getAnnotationOfType in class JavaMember

Parameters:

typeName - The fully qualified class name of the Annotation type to retrieve.

Returns:

The JavaAnnotation matching the given type. Will throw an IllegalArgumentException if no matching Annotation is present.

See Also:

• HasAnnotations.tryGetAnnotationOfType(String)
• HasAnnotations.getAnnotationOfType(Class)

tryGetAnnotationOfType

public Optional<? extends JavaAnnotation<? extends JavaCodeUnit>> tryGetAnnotationOfType(String typeName)

Specified by:

tryGetAnnotationOfType in interface HasAnnotations<JavaMember>

Overrides:

tryGetAnnotationOfType in class JavaMember

Parameters:

typeName - The fully qualified class name of the Annotation type to retrieve.

Returns:

The JavaAnnotation matching the given type or Optional.empty() if there is no Annotation with the respective annotation type.

See Also:

• HasAnnotations.getAnnotationOfType(String)
• HasAnnotations.tryGetAnnotationOfType(Class)

getTypeParameters

@PublicAPI(usage=ACCESS)
public List<? extends JavaTypeVariable<? extends JavaCodeUnit>> getTypeParameters()

Specified by:

getTypeParameters in interface HasTypeParameters<JavaCodeUnit>

Returns:

the type parameters of this object, e.g. for any generic method

<A, B> B someMethod(A a) {..}

this would return the JavaTypeVariables [A, B].
If this object is non-generic, e.g. a method

void someMethod() {..}

an empty list will be returned.

getParameterAnnotations

@PublicAPI(usage=ACCESS)
public List<Set<JavaAnnotation<JavaParameter>>> getParameterAnnotations()