Package com.tngtech.archunit.core.domain

Class JavaMethod

java.lang.Object

com.tngtech.archunit.core.domain.JavaMember

com.tngtech.archunit.core.domain.JavaCodeUnit

com.tngtech.archunit.core.domain.JavaMethod

All Implemented Interfaces:

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

@PublicAPI(usage=ACCESS)
public final class JavaMethod
extends JavaCodeUnit

Nested Class Summary

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

JavaCodeUnit.Functions, JavaCodeUnit.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

Method Summary

Modifier and Type	Method	Description
Set<JavaCodeUnitAccess<?>>	getAccessesToSelf()
JavaAnnotation<JavaMethod>	getAnnotationOfType(String typeName)
Set<JavaAnnotation<JavaMethod>>	getAnnotations()
Set<JavaMethodCall>	getCallsOfSelf()
Optional<Object>	getDefaultValue()	Returns the default value of this annotation method, if the method is an annotation method and has a declared default.
String	getDescription()
Set<JavaMethodReference>	getReferencesToSelf()
ThrowsClause<JavaMethod>	getThrowsClause()
List<JavaTypeVariable<JavaMethod>>	getTypeParameters()
boolean	isMethod()
Method	reflect()	Resolves the respective Member from the classpath. NOTE: This method will throw an exception, if the owning Class or any of its dependencies can't be found on the classpath.
Optional<JavaAnnotation<JavaMethod>>	tryGetAnnotationOfType(String typeName)

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

getAccessesFromSelf, getCallsFromSelf, getCodeUnitReferencesFromSelf, getConstructorCallsFromSelf, getConstructorReferencesFromSelf, getExceptionTypes, getFieldAccesses, getFullName, getInstanceofChecks, getMethodCallsFromSelf, getMethodReferencesFromSelf, getParameterAnnotations, getParameters, getParameterTypes, getRawParameterTypes, getRawReturnType, getReferencedClassObjects, getReturnType, getTryCatchBlocks, isConstructor

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

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

Methods inherited from class java.lang.Object

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

Method Details

getTypeParameters

public List<JavaTypeVariable<JavaMethod>> getTypeParameters()

Specified by:

getTypeParameters in interface HasTypeParameters<JavaCodeUnit>

Overrides:

getTypeParameters in class 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.

getThrowsClause

@PublicAPI(usage=ACCESS)
public ThrowsClause<JavaMethod> getThrowsClause()

Specified by:

getThrowsClause in interface HasThrowsClause<JavaCodeUnit>

Specified by:

getThrowsClause in class JavaCodeUnit

getDefaultValue

@PublicAPI(usage=ACCESS)
public Optional<Object> getDefaultValue()

Returns the default value of this annotation method, if the method is an annotation method and has a declared default. It's analogue to Method.getDefaultValue(), but returns Optional.absent() instead of null.

Returns:

Optional.of(defaultValue) if applicable, otherwise Optional.absent()

isMethod

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

Overrides:

isMethod in class JavaCodeUnit

getCallsOfSelf

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

Specified by:

getCallsOfSelf in class JavaCodeUnit

getReferencesToSelf

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

getAccessesToSelf

@PublicAPI(usage=ACCESS)
public Set<JavaCodeUnitAccess<?>> getAccessesToSelf()

Specified by:

getAccessesToSelf in class JavaMember

getAnnotations

public Set<JavaAnnotation<JavaMethod>> getAnnotations()

Specified by:

getAnnotations in interface HasAnnotations<JavaMember>

Overrides:

getAnnotations in class JavaCodeUnit

getAnnotationOfType

public JavaAnnotation<JavaMethod> getAnnotationOfType(String typeName)

Specified by:

getAnnotationOfType in interface HasAnnotations<JavaMember>

Overrides:

getAnnotationOfType in class JavaCodeUnit

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<JavaAnnotation<JavaMethod>> tryGetAnnotationOfType(String typeName)

Specified by:

tryGetAnnotationOfType in interface HasAnnotations<JavaMember>

Overrides:

tryGetAnnotationOfType in class JavaCodeUnit

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)

reflect

@PublicAPI(usage=ACCESS)
public Method reflect()

Description copied from class: JavaMember

Resolves the respective Member from the classpath.
NOTE: This method will throw an exception, if the owning Class or any of its dependencies can't be found on the classpath.

Specified by:

reflect in class JavaMember

Returns:

The Member equivalent to this JavaMember

getDescription

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