Package com.tngtech.archunit.core.domain

Class JavaClass

java.lang.Object

com.tngtech.archunit.core.domain.JavaClass

All Implemented Interfaces:

HasDescription, JavaType, CanBeAnnotated, HasAnnotations<JavaClass>, HasModifiers, HasName, HasName.AndFullName, HasSourceCodeLocation, HasTypeParameters<JavaClass>

@PublicAPI(usage=ACCESS)
public final class JavaClass
extends Object
implements JavaType, HasName.AndFullName, HasTypeParameters<JavaClass>, HasAnnotations<JavaClass>, HasModifiers, HasSourceCodeLocation

Nested Class Summary

Nested Classes

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

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()
Set<JavaAccess<?>>	getAccessesToSelf()	Like getAccessesFromSelf() but this class is target instead of origin.
Set<JavaAccess<?>>	getAllAccessesFromSelf()
Set<JavaClass>	getAllClassesSelfIsAssignableTo()
Set<JavaConstructor>	getAllConstructors()
Set<JavaField>	getAllFields()
Set<JavaClass>	getAllInvolvedRawTypes()	Returns the set of all raw types that are involved in this type.
Set<JavaMember>	getAllMembers()
Set<JavaMethod>	getAllMethods()
Set<JavaClass>	getAllRawInterfaces()
List<JavaClass>	getAllRawSuperclasses()
Set<JavaClass>	getAllSubclasses()
<A extends Annotation> A	getAnnotationOfType(Class<A> type)
JavaAnnotation<JavaClass>	getAnnotationOfType(String typeName)
Set<JavaAnnotation<JavaClass>>	getAnnotations()
Set<JavaAnnotation<?>>	getAnnotationsWithParameterTypeOfSelf()
Set<JavaAnnotation<?>>	getAnnotationsWithTypeOfSelf()
JavaClass	getBaseComponentType()	The base component type is the class' component type if it is a one-dimensional array, the repeated application of getComponentType() if it is a multi-dimensional array, or the class itself if it is no array.
List<JavaClass>	getClassHierarchy()
Set<JavaCodeUnitAccess<?>>	getCodeUnitAccessesFromSelf()
Set<JavaCodeUnitAccess<?>>	getCodeUnitAccessesToSelf()	Like getCodeUnitAccessesFromSelf() but this class is target instead of origin.
Set<JavaCall<?>>	getCodeUnitCallsFromSelf()	Returns all calls of this class to methods or constructors.
Set<JavaCall<?>>	getCodeUnitCallsToSelf()	Like getCodeUnitCallsFromSelf() but this class is target instead of origin.
Set<JavaCodeUnitReference<?>>	getCodeUnitReferencesFromSelf()
Set<JavaCodeUnitReference<?>>	getCodeUnitReferencesToSelf()	Like getCodeUnitReferencesFromSelf() but this class is target instead of origin.
Set<JavaCodeUnit>	getCodeUnits()
JavaCodeUnit	getCodeUnitWithParameterTypeNames(String name, String... parameters)	Same as getCodeUnitWithParameterTypes(String, Class[]), but with parameter signature specified as full class names
JavaCodeUnit	getCodeUnitWithParameterTypeNames(String name, List<String> parameters)
JavaCodeUnit	getCodeUnitWithParameterTypes(String name, Class<?>... parameters)
JavaCodeUnit	getCodeUnitWithParameterTypes(String name, List<Class<?>> parameters)
JavaClass	getComponentType()	This is a convenience method for tryGetComponentType() in cases where clients know that this type is certainly an array type and thus the component type present.
JavaConstructor	getConstructor()
JavaConstructor	getConstructor(Class<?>... parameters)
JavaConstructor	getConstructor(String... parameters)	Same as getConstructor(Class[]), but with parameter signature specified as full class names.
Set<JavaConstructorCall>	getConstructorCallsFromSelf()
Set<JavaConstructorCall>	getConstructorCallsToSelf()	Like getConstructorCallsFromSelf() but this class is target instead of origin.
Set<JavaConstructorReference>	getConstructorReferencesFromSelf()
Set<JavaConstructorReference>	getConstructorReferencesToSelf()	Like getConstructorReferencesFromSelf() but this class is target instead of origin.
Set<JavaConstructor>	getConstructors()
Set<JavaConstructor>	getConstructorsWithParameterTypeOfSelf()
Set<ThrowsDeclaration<JavaConstructor>>	getConstructorsWithThrowsDeclarationTypeOfSelf()
String	getDescription()
Set<Dependency>	getDirectDependenciesFromSelf()
Set<Dependency>	getDirectDependenciesToSelf()	Like getDirectDependenciesFromSelf(), but instead returns all dependencies where this class is target.
Optional<JavaClass>	getEnclosingClass()	Returns the enclosing class if this class is nested within another class.
Optional<JavaCodeUnit>	getEnclosingCodeUnit()	Returns the enclosing JavaCodeUnit if this class is declared within the context of a JavaCodeUnit, e.g.
JavaEnumConstant	getEnumConstant(String name)
Set<JavaEnumConstant>	getEnumConstants()
JavaField	getField(String name)
Set<JavaFieldAccess>	getFieldAccessesFromSelf()
Set<JavaFieldAccess>	getFieldAccessesToSelf()
Set<JavaField>	getFields()
Set<JavaField>	getFieldsWithTypeOfSelf()
String	getFullName()
Set<InstanceofCheck>	getInstanceofChecks()
Set<InstanceofCheck>	getInstanceofChecksWithTypeOfSelf()
Set<JavaType>	getInterfaces()
Set<JavaMember>	getMembers()
JavaMethod	getMethod(String name)
JavaMethod	getMethod(String name, Class<?>... parameters)
JavaMethod	getMethod(String name, String... parameters)	Same as getMethod(String, Class[]), but with parameter signature specified as fully qualified class names.
Set<JavaMethodCall>	getMethodCallsFromSelf()
Set<JavaMethodCall>	getMethodCallsToSelf()	Like getMethodCallsFromSelf() but this class is target instead of origin.
Set<JavaMethodReference>	getMethodReferencesFromSelf()
Set<JavaMethodReference>	getMethodReferencesToSelf()	Like getMethodReferencesFromSelf() but this class is target instead of origin.
Set<JavaMethod>	getMethods()
Set<JavaMethod>	getMethodsWithParameterTypeOfSelf()
Set<JavaMethod>	getMethodsWithReturnTypeOfSelf()
Set<ThrowsDeclaration<JavaMethod>>	getMethodThrowsDeclarationsWithTypeOfSelf()
Set<JavaModifier>	getModifiers()
String	getName()
JavaPackage	getPackage()
String	getPackageName()
Set<JavaClass>	getRawInterfaces()
Optional<JavaClass>	getRawSuperclass()
Set<ReferencedClassObject>	getReferencedClassObjects()
String	getSimpleName()
Optional<Source>	getSource()
SourceCodeLocation	getSourceCodeLocation()
Optional<JavaStaticInitializer>	getStaticInitializer()
Set<JavaClass>	getSubclasses()
Optional<JavaType>	getSuperclass()
Set<ThrowsDeclaration<? extends JavaCodeUnit>>	getThrowsDeclarations()
Set<Dependency>	getTransitiveDependenciesFromSelf()	Returns the transitive closure of all dependencies originating from this class, i.e.
List<JavaTypeVariable<JavaClass>>	getTypeParameters()
boolean	isAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate)	Returns true, if this element is annotated with an annotation matching the given predicate.
boolean	isAnnotatedWith(Class<? extends Annotation> annotationType)	Returns true, if this element is annotated with the given annotation type.
boolean	isAnnotatedWith(String annotationTypeName)
boolean	isAnnotation()
boolean	isAnonymousClass()	An anonymous class is an inner class that is automatically derived from a class creation expression with a declared class body, e.g.
boolean	isArray()
boolean	isAssignableFrom(DescribedPredicate<? super JavaClass> predicate)
boolean	isAssignableFrom(Class<?> type)
boolean	isAssignableFrom(String typeName)
boolean	isAssignableTo(DescribedPredicate<? super JavaClass> predicate)
boolean	isAssignableTo(Class<?> type)
boolean	isAssignableTo(String typeName)
boolean	isEnum()
boolean	isEquivalentTo(Class<?> clazz)
boolean	isFullyImported()
boolean	isInnerClass()	An inner class is a nested class that is not explicitly or implicitly declared static. Example:
boolean	isInterface()
boolean	isLocalClass()	A local class is a nested class that is not a member of any class and that has a name. Example:
boolean	isMemberClass()	A member class is a class whose declaration is directly enclosed in the body of another class or interface declaration. Example:
boolean	isMetaAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate)	Returns true, if this element is meta-annotated with an annotation matching the given predicate.
boolean	isMetaAnnotatedWith(Class<? extends Annotation> type)	Returns true, if this element is meta-annotated with the given annotation type.
boolean	isMetaAnnotatedWith(String typeName)
boolean	isNestedClass()	A nested class is any class whose declaration occurs within the body of another class or interface. Example:
boolean	isPrimitive()
boolean	isRecord()	Returns whether this class is a record according to the Java Language Specification.
boolean	isTopLevelClass()	A top level class is a class that is not a nested class, i.e.
Class<?>	reflect()	Resolves the respective Class from the classpath. NOTE: This method will throw an exception, if the respective Class or any of its dependencies can't be found on the classpath.
JavaClass	toErasure()	Converts this JavaType into the erased type (compare the Java Language Specification).
String	toString()
<A extends Annotation> Optional<A>	tryGetAnnotationOfType(Class<A> type)
Optional<JavaAnnotation<JavaClass>>	tryGetAnnotationOfType(String typeName)	Same as tryGetAnnotationOfType(Class), but takes the type name.
Optional<JavaCodeUnit>	tryGetCodeUnitWithParameterTypeNames(String name, List<String> parameters)	Same as getCodeUnitWithParameterTypeNames(String, List), but will return Optional.empty() if there is no such JavaCodeUnit.
Optional<JavaCodeUnit>	tryGetCodeUnitWithParameterTypes(String name, List<Class<?>> parameters)	Same as getCodeUnitWithParameterTypes(String, List), but will return Optional.empty() if there is no such JavaCodeUnit.
Optional<JavaClass>	tryGetComponentType()	Returns the component type of this class, if this class is an array, otherwise Optional.empty().
Optional<JavaConstructor>	tryGetConstructor()
Optional<JavaConstructor>	tryGetConstructor(Class<?>... parameters)
Optional<JavaConstructor>	tryGetConstructor(String... parameters)	Same as tryGetConstructor(Class[]), but with parameter signature specified as fully qualified class names.
Optional<JavaEnumConstant>	tryGetEnumConstant(String name)
Optional<JavaField>	tryGetField(String name)
Optional<JavaMethod>	tryGetMethod(String name)
Optional<JavaMethod>	tryGetMethod(String name, Class<?>... parameters)
Optional<JavaMethod>	tryGetMethod(String name, String... parameters)	Same as tryGetMethod(String, Class[]), but with parameter signature specified as fully qualified class names.

Methods inherited from class java.lang.Object

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

Method Details

getSource

@PublicAPI(usage=ACCESS)
public Optional<Source> getSource()

Returns:

The Source of this JavaClass, i.e. where this class has been imported from

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.

getDescription

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

Specified by:

getDescription in interface HasDescription

getName

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

Specified by:

getName in interface HasName

Returns:

The fully qualified name of this JavaClass, compare Class.getName() of the Reflection API

getFullName

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

Specified by:

getFullName in interface HasName.AndFullName

Returns:

The fully qualified name of this JavaClass, i.e. the result is the same as invoking getName()

getSimpleName

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

getPackage

@PublicAPI(usage=ACCESS)
public JavaPackage getPackage()

getPackageName

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

isPrimitive

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

isInterface

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

isEnum

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

isAnnotation

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

isRecord

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

Returns whether this class is a record according to the Java Language Specification.

Records were added as preview feature with JDK 14/15 and were released as regular feature with JDK 16.

See also JEP 395: Records

tryGetEnumConstant

@PublicAPI(usage=ACCESS)
public Optional<JavaEnumConstant> tryGetEnumConstant(String name)

getEnumConstant

@PublicAPI(usage=ACCESS)
public JavaEnumConstant getEnumConstant(String name)

getEnumConstants

@PublicAPI(usage=ACCESS)
public Set<JavaEnumConstant> getEnumConstants()

isArray

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

getComponentType

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

This is a convenience method for tryGetComponentType() in cases where clients know that this type is certainly an array type and thus the component type present.

Returns:

The result of tryGetComponentType()

Throws:

IllegalStateException - if this class is no array

tryGetComponentType

@PublicAPI(usage=ACCESS)
public Optional<JavaClass> tryGetComponentType()

Returns the component type of this class, if this class is an array, otherwise Optional.empty(). The component type is the type of the elements of an array type. Consider String[], then the component type would be String. Likewise for String[][] the component type would be String[].

Returns:

The component type, if this type is an array, otherwise Optional.empty()

getBaseComponentType

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

The base component type is the class' component type if it is a one-dimensional array, the repeated application of getComponentType() if it is a multi-dimensional array, or the class itself if it is no array. For example, the base component type of int, int[], int[][], ... is always int.

Returns:

The base component type of this class

isTopLevelClass

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

A top level class is a class that is not a nested class, i.e. not declared within the body of another class.

Example:

 public class TopLevel {
     class NestedNonStatic {}
     static class NestedStatic {}

     void method() {
         class NestedLocal {}

         new NestedAnonymous() {}
     }
 }
 

Of all these class declarations only TopLevel is a top level class, since all other classes are declared within the body of TopLevel and are thereby nested classes.

Compare e.g. Java Language Specification

Returns:

true if this class is a top level class, i.e. not nested inside of any other class, false otherwise

See Also:

• isNestedClass()
• isMemberClass()
• isInnerClass()
• isLocalClass()
• isAnonymousClass()

isNestedClass

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

A nested class is any class whose declaration occurs within the body of another class or interface.

Example:

 public class TopLevel {
     class NestedNonStatic {}
     static class NestedStatic {}

     void method() {
         class NestedLocal {}

         new NestedAnonymous() {}
     }
 }
 

All classes NestedNonStatic, NestedStatic, NestedLocal and the class the compiler creates for the anonymous class derived from "new NestedAnonymous() {}" (which will have some generated name like TopLevel$1) are considered nested classes. TopLevel on the other side is no nested class.

Compare e.g. Java Language Specification

Returns:

true if this class is nested, i.e. declared within another class, false otherwise (i.e. for top-level classes)

See Also:

• isTopLevelClass()
• isMemberClass()
• isInnerClass()
• isLocalClass()
• isAnonymousClass()

isMemberClass

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

A member class is a class whose declaration is directly enclosed in the body of another class or interface declaration.

Example:

 public class TopLevel {
     class MemberClassNonStatic {}
     static class MemberClassStatic {}

     void method() {
         class NoMemberLocal {}

         new NoMemberAnonymous() {}
     }
 }
 

Both MemberClassNonStatic and MemberClassStatic are member classes, since they are directly declared within the body of TopLevel. On the other hand NoMemberLocal and the class the compiler creates for the anonymous class derived from "new NoMemberAnonymous() {}" (which will have some generated name like TopLevel$1), as well as TopLevel itself, are not considered member classes.

Compare e.g. Java Language Specification

Returns:

true if this class is a member class, i.e. directly declared within the body of another class, false otherwise

See Also:

• isTopLevelClass()
• isNestedClass()
• isInnerClass()
• isLocalClass()
• isAnonymousClass()

isInnerClass

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

An inner class is a nested class that is not explicitly or implicitly declared static.

Example:

 public class TopLevel {
     class InnerMemberClass {}
     static class NoInnerClassSinceDeclaredStatic {}
     interface NoInnerClassSinceInterface {}

     void method() {
         class InnerLocalClass {}

         new InnerAnonymousClass() {}
     }
 }
 

The classes InnerMemberClass, InnerLocalClass and the class the compiler creates for the anonymous class derived from "new InnerAnonymousClass() {}" (which will have some generated name like TopLevel$1) are inner classes since they are nested but not static. On the other hand NoInnerClassSinceDeclaredStatic, NoInnerClassSinceInterface and TopLevel are no inner classes, because the former two explicitly or implicitly have the static modifier while the latter one is a top level class.

Compare e.g. Java Language Specification

Returns:

true if this class is an inner class (i.e. nested but non-static) false otherwise

See Also:

• isTopLevelClass()
• isNestedClass()
• isMemberClass()
• isLocalClass()
• isAnonymousClass()

isLocalClass

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

A local class is a nested class that is not a member of any class and that has a name.

Example:

 public class TopLevel {
     class InnerClass {}
     static class NestedStaticClass {}

     void method() {
         class LocalClass {}

         new AnonymousClass() {}
     }
 }
 

Only The class LocalClass is a local class, since it is a nested class that is not a member class, but it has the name "LocalClass".
All the other classes TopLevel, InnerClass, NestedStaticClass and the class the compiler creates for the anonymous class derived from "new AnonymousClass() {}" (which will have some generated name like TopLevel$1) are considered non-local, since they either are top level, directly declared within the body of TopLevel or are anonymous and thus have no name.

Compare e.g. Java Language Specification

Returns:

true if this class is local class, false otherwise

See Also:

• isTopLevelClass()
• isNestedClass()
• isMemberClass()
• isInnerClass()
• isAnonymousClass()

isAnonymousClass

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

An anonymous class is an inner class that is automatically derived from a class creation expression with a declared class body, e.g. new Example(){ <some-body> }.
The compiler will automatically create a class backing this instance, typically with an autogenerated name like SomeClass$1, where SomeClass is the class holding the class creation expression.

Example:

 public class TopLevel {
     class InnerClass {}
     static class NestedStaticClass {}

     void method() {
         class LocalClass {}

         new AnonymousClass() {}
     }
 }
 

Only the class the compiler creates for the anonymous class derived from "new AnonymousClass() {}" (which will have some generated name like TopLevel$1) is considered an anonymous class.
All the other classes TopLevel, InnerClass, NestedStaticClass and LocalClass are considered non-anonymous.

Compare e.g. Java Language Specification

Returns:

true if this class is an anonymous class, false otherwise

See Also:

• isTopLevelClass()
• isNestedClass()
• isMemberClass()
• isInnerClass()
• isLocalClass()

getModifiers

@PublicAPI(usage=ACCESS)
public Set<JavaModifier> getModifiers()

Specified by:

getModifiers in interface HasModifiers

isAnnotatedWith

@PublicAPI(usage=ACCESS)
public boolean isAnnotatedWith(Class<? extends Annotation> annotationType)

Description copied from interface: CanBeAnnotated

Returns true, if this element is annotated with the given annotation type.

Specified by:

isAnnotatedWith in interface CanBeAnnotated

Parameters:

annotationType - The type of the annotation to check for

isAnnotatedWith

@PublicAPI(usage=ACCESS)
public boolean isAnnotatedWith(String annotationTypeName)

Specified by:

isAnnotatedWith in interface CanBeAnnotated

Parameters:

annotationTypeName - Fully qualified class name of a specific type of Annotation

See Also:

• CanBeAnnotated.isAnnotatedWith(Class)

isAnnotatedWith

@PublicAPI(usage=ACCESS)
public boolean isAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate)

Description copied from interface: CanBeAnnotated

Returns true, if this element is annotated with an annotation matching the given predicate.

Specified by:

isAnnotatedWith in interface CanBeAnnotated

Parameters:

predicate - Qualifies matching annotations

isMetaAnnotatedWith

@PublicAPI(usage=ACCESS)
public boolean isMetaAnnotatedWith(Class<? extends Annotation> type)

Description copied from interface: CanBeAnnotated

Returns true, if this element is meta-annotated with the given annotation type. A meta-annotation is an annotation that is declared on another annotation.

This method also returns true if this element is directly annotated with the given annotation type.

Specified by:

isMetaAnnotatedWith in interface CanBeAnnotated

Parameters:

type - The type of the annotation to check for

isMetaAnnotatedWith

@PublicAPI(usage=ACCESS)
public boolean isMetaAnnotatedWith(String typeName)

Specified by:

isMetaAnnotatedWith in interface CanBeAnnotated

Parameters:

typeName - Fully qualified class name of a specific type of Annotation

See Also:

• CanBeAnnotated.isMetaAnnotatedWith(Class)

isMetaAnnotatedWith

@PublicAPI(usage=ACCESS)
public boolean isMetaAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate)

Description copied from interface: CanBeAnnotated

Returns true, if this element is meta-annotated with an annotation matching the given predicate. A meta-annotation is an annotation that is declared on another annotation.

This method also returns true if this element is directly annotated with an annotation matching the given predicate.

Specified by:

isMetaAnnotatedWith in interface CanBeAnnotated

Parameters:

predicate - Qualifies matching annotations

getAnnotationOfType

@PublicAPI(usage=ACCESS)
public <A extends Annotation> A getAnnotationOfType(Class<A> type)

Specified by:

getAnnotationOfType in interface HasAnnotations<JavaClass>

Type Parameters:

A - The type of the Annotation to retrieve

Parameters:

type - A given annotation type to match JavaAnnotations against

Returns:

An Annotation of the given annotation type

Throws:

IllegalArgumentException - if the class is not annotated with the given type

See Also:

• isAnnotatedWith(Class)
• tryGetAnnotationOfType(Class)

getAnnotationOfType

@PublicAPI(usage=ACCESS)
public JavaAnnotation<JavaClass> getAnnotationOfType(String typeName)

Specified by:

getAnnotationOfType in interface HasAnnotations<JavaClass>

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)

getAnnotations

@PublicAPI(usage=ACCESS)
public Set<JavaAnnotation<JavaClass>> getAnnotations()

Specified by:

getAnnotations in interface HasAnnotations<JavaClass>

tryGetAnnotationOfType

@PublicAPI(usage=ACCESS)
public <A extends Annotation> Optional<A> tryGetAnnotationOfType(Class<A> type)

Specified by:

tryGetAnnotationOfType in interface HasAnnotations<JavaClass>

Type Parameters:

A - The type of the Annotation to retrieve

Parameters:

type - A given annotation type to match JavaAnnotations against

Returns:

An Optional containing an Annotation of the given annotation type, if this class is annotated with the given type, otherwise Optional.absent()

See Also:

• isAnnotatedWith(Class)
• getAnnotationOfType(Class)

tryGetAnnotationOfType

@PublicAPI(usage=ACCESS)
public Optional<JavaAnnotation<JavaClass>> tryGetAnnotationOfType(String typeName)

Same as tryGetAnnotationOfType(Class), but takes the type name.

Specified by:

tryGetAnnotationOfType in interface HasAnnotations<JavaClass>

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<JavaTypeVariable<JavaClass>> getTypeParameters()

Specified by:

getTypeParameters in interface HasTypeParameters<JavaClass>

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.

getInstanceofChecks

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

getReferencedClassObjects

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

toErasure

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

Description copied from interface: JavaType

Converts this JavaType into the erased type (compare the Java Language Specification). In particular this will result in

• the class itself, if this type is a JavaClass
• the JavaClass equivalent to Object, if this type is an unbound JavaTypeVariable
• the JavaClass equivalent to the erasure of the left most bound, if this type is a bound JavaTypeVariable
• if this type is a JavaGenericArrayType, the erasure will be the JavaClass equivalent to the array type that has the erasure of the generic component type of this type as its component type; e.g. take the generic array type T[][] where T is unbound, then the erasure will be the array type Object[][]

Specified by:

toErasure in interface JavaType

getAllInvolvedRawTypes

public Set<JavaClass> getAllInvolvedRawTypes()

Description copied from interface: JavaType

Returns the set of all raw types that are involved in this type. If this type is a JavaClass, then this method trivially returns only the class itself. If this type is a JavaParameterizedType, JavaTypeVariable, JavaWildcardType, etc., then this method returns all raw types involved in type arguments and upper and lower bounds recursively. If this type is an array type, then this method returns all raw types involved in the component type of the array type.

Examples:
For the parameterized type

 List<String>

the result would be the classes [List, String].
For the parameterized type

 Map<? extends Serializable, List<? super Integer[]>>

the result would be [Map, Serializable, List, Integer].
And for the type variable

 T extends List<? super Integer>

the result would be [List, Integer].
Thus, this method offers a quick way to determine all types a (possibly complex) type depends on.

Specified by:

getAllInvolvedRawTypes in interface JavaType

Returns:

All raw types involved in this JavaType

getRawSuperclass

@PublicAPI(usage=ACCESS)
public Optional<JavaClass> getRawSuperclass()

getSuperclass

@PublicAPI(usage=ACCESS)
public Optional<JavaType> getSuperclass()

getClassHierarchy

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

Returns:

The complete class hierarchy, i.e. the class itself and the result of getAllRawSuperclasses()

getAllRawSuperclasses

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

Returns:

All super classes sorted ascending by distance in the class hierarchy, i.e. first the direct super class, then the super class of the super class and so on. Includes Object.class in the result.

getSubclasses

@PublicAPI(usage=ACCESS)
public Set<JavaClass> getSubclasses()

getInterfaces

@PublicAPI(usage=ACCESS)
public Set<JavaType> getInterfaces()

getRawInterfaces

@PublicAPI(usage=ACCESS)
public Set<JavaClass> getRawInterfaces()

getAllRawInterfaces

@PublicAPI(usage=ACCESS)
public Set<JavaClass> getAllRawInterfaces()

getAllClassesSelfIsAssignableTo

@PublicAPI(usage=ACCESS)
public Set<JavaClass> getAllClassesSelfIsAssignableTo()

Returns:

All classes, this class is assignable to, in particular

• self
• superclasses this class extends
• interfaces this class implements

getEnclosingClass

@PublicAPI(usage=ACCESS)
public Optional<JavaClass> getEnclosingClass()

Returns the enclosing class if this class is nested within another class. Otherwise Optional.empty().

Take for example

 class OuterClass {
     class InnerClass{
     }
 }
 

Then InnerClass.getEnclosingClass() would return Optional.of(OuterClass). While OuterClass.getEnclosingClass() would return Optional.empty().

getEnclosingCodeUnit

@PublicAPI(usage=ACCESS)
public Optional<JavaCodeUnit> getEnclosingCodeUnit()

Returns the enclosing JavaCodeUnit if this class is declared within the context of a JavaCodeUnit, e.g. a method or a constructor. Otherwise Optional.empty().

Take for example

 class OuterClass {
     OuterClass() {
         // creates a new anonymous class within the scope of the constructor
         new Serializable() {};
     }

     void someMethod() {
         // creates a new local class within the scope of the method
         class LocalClass {}
     }

     class InnerClass {}
 }
 

Then anonymousSerializable.getEnclosingCodeUnit() would return the JavaConstructor OuterClass() and LocalClass.getEnclosingCodeUnit() would return the JavaMethod void someMethod().
On the other hand OuterClass.getEnclosingCodeUnit() or InnerClass.getEnclosingCodeUnit() would return Optional.empty(), since they are not defined within the context of a JavaCodeUnit.

getAllSubclasses

@PublicAPI(usage=ACCESS)
public Set<JavaClass> getAllSubclasses()

getMembers

@PublicAPI(usage=ACCESS)
public Set<JavaMember> getMembers()

getAllMembers

@PublicAPI(usage=ACCESS)
public Set<JavaMember> getAllMembers()

getFields

@PublicAPI(usage=ACCESS)
public Set<JavaField> getFields()

getAllFields

@PublicAPI(usage=ACCESS)
public Set<JavaField> getAllFields()

getField

@PublicAPI(usage=ACCESS)
public JavaField getField(String name)

Returns:

The field with the given name.

Throws:

IllegalArgumentException - If this class does not have such a field.

tryGetField

@PublicAPI(usage=ACCESS)
public Optional<JavaField> tryGetField(String name)

Returns:

The field with the given name, if this class has such a field, otherwise Optional.empty().

getCodeUnits

@PublicAPI(usage=ACCESS)
public Set<JavaCodeUnit> getCodeUnits()

getCodeUnitWithParameterTypes

@PublicAPI(usage=ACCESS)
public JavaCodeUnit getCodeUnitWithParameterTypes(String name,
 Class<?>... parameters)

Parameters:

name - The name of the code unit, can be a method name, but also CONSTRUCTOR_NAME or STATIC_INITIALIZER_NAME

parameters - The parameter signature of the method specified as Class Objects

Returns:

A code unit (method, constructor or static initializer) with the given signature

getCodeUnitWithParameterTypeNames

@PublicAPI(usage=ACCESS)
public JavaCodeUnit getCodeUnitWithParameterTypeNames(String name,
 String... parameters)

Same as getCodeUnitWithParameterTypes(String, Class[]), but with parameter signature specified as full class names

getCodeUnitWithParameterTypes

@PublicAPI(usage=ACCESS)
public JavaCodeUnit getCodeUnitWithParameterTypes(String name,
 List<Class<?>> parameters)

See Also:

• getCodeUnitWithParameterTypes(String, Class[])

tryGetCodeUnitWithParameterTypes

@PublicAPI(usage=ACCESS)
public Optional<JavaCodeUnit> tryGetCodeUnitWithParameterTypes(String name,
 List<Class<?>> parameters)

Same as getCodeUnitWithParameterTypes(String, List), but will return Optional.empty() if there is no such JavaCodeUnit.

getCodeUnitWithParameterTypeNames

@PublicAPI(usage=ACCESS)
public JavaCodeUnit getCodeUnitWithParameterTypeNames(String name,
 List<String> parameters)

See Also:

• getCodeUnitWithParameterTypeNames(String, String...)

tryGetCodeUnitWithParameterTypeNames

@PublicAPI(usage=ACCESS)
public Optional<JavaCodeUnit> tryGetCodeUnitWithParameterTypeNames(String name,
 List<String> parameters)

Same as getCodeUnitWithParameterTypeNames(String, List), but will return Optional.empty() if there is no such JavaCodeUnit.

getMethod

@PublicAPI(usage=ACCESS)
public JavaMethod getMethod(String name)

Returns:

The method with the given name and with zero parameters.

Throws:

IllegalArgumentException - If this class does not have such a method.

getMethod

@PublicAPI(usage=ACCESS)
public JavaMethod getMethod(String name,
 Class<?>... parameters)

Returns:

The method with the given name and the given raw parameter types.

Throws:

IllegalArgumentException - If this class does not have such a method.

getMethod

@PublicAPI(usage=ACCESS)
public JavaMethod getMethod(String name,
 String... parameters)

Same as getMethod(String, Class[]), but with parameter signature specified as fully qualified class names.

tryGetMethod

@PublicAPI(usage=ACCESS)
public Optional<JavaMethod> tryGetMethod(String name)

Returns:

The method with the given name and with zero parameters, if this class has such a method, otherwise Optional.empty().

tryGetMethod

@PublicAPI(usage=ACCESS)
public Optional<JavaMethod> tryGetMethod(String name,
 Class<?>... parameters)

Returns:

The method with the given name and the given parameter types, if this class has such a method, otherwise Optional.empty().

tryGetMethod

@PublicAPI(usage=ACCESS)
public Optional<JavaMethod> tryGetMethod(String name,
 String... parameters)

Same as tryGetMethod(String, Class[]), but with parameter signature specified as fully qualified class names.

getMethods

@PublicAPI(usage=ACCESS)
public Set<JavaMethod> getMethods()

getAllMethods

@PublicAPI(usage=ACCESS)
public Set<JavaMethod> getAllMethods()

getConstructor

@PublicAPI(usage=ACCESS)
public JavaConstructor getConstructor()

Returns:

The constructor with zero parameters.

Throws:

IllegalArgumentException - If this class does not have such a constructor.

getConstructor

@PublicAPI(usage=ACCESS)
public JavaConstructor getConstructor(Class<?>... parameters)

Returns:

The constructor with the given parameter types. Note that these are the raw parameter types, which can include synthetic parameter types under certain circumstances. For example inner classes have the outer class as synthetic first parameter type and enums have a String name and int ordinal as prepended synthetic parameters. Unfortunately there is no fixed rule, e.g. local class constructors can have multiple synthetic parameters appended to the parameters derived from the source code.

Throws:

IllegalArgumentException - If this class does not have a constructor with the given parameter types.

getConstructor

@PublicAPI(usage=ACCESS)
public JavaConstructor getConstructor(String... parameters)

Same as getConstructor(Class[]), but with parameter signature specified as full class names.

tryGetConstructor

@PublicAPI(usage=ACCESS)
public Optional<JavaConstructor> tryGetConstructor()

Returns:

The constructor with zero parameters, if this class has such a constructor, otherwise Optional.empty().

tryGetConstructor

@PublicAPI(usage=ACCESS)
public Optional<JavaConstructor> tryGetConstructor(Class<?>... parameters)

Returns:

The constructor with the given parameter types (compare getConstructor(Class[])), if this class has such a constructor, otherwise Optional.empty().

tryGetConstructor

@PublicAPI(usage=ACCESS)
public Optional<JavaConstructor> tryGetConstructor(String... parameters)

Same as tryGetConstructor(Class[]), but with parameter signature specified as fully qualified class names.

getConstructors

@PublicAPI(usage=ACCESS)
public Set<JavaConstructor> getConstructors()

getAllConstructors

@PublicAPI(usage=ACCESS)
public Set<JavaConstructor> getAllConstructors()

getStaticInitializer

@PublicAPI(usage=ACCESS)
public Optional<JavaStaticInitializer> getStaticInitializer()

getAccessesFromSelf

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

Returns:

All accesses of this class to any members (fields/methods/constructors)

See Also:

• getFieldAccessesFromSelf()
• getCodeUnitAccessesFromSelf()
• getCodeUnitCallsFromSelf()
• getConstructorCallsFromSelf()
• getMethodCallsFromSelf()
• getCodeUnitReferencesFromSelf()
• getConstructorReferencesFromSelf()
• getMethodReferencesFromSelf()

getAllAccessesFromSelf

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

Returns:

getAccessesFromSelf() but for every class in the class hierarchy (i.e. all superclasses)

getFieldAccessesFromSelf

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

Returns:

All accesses of this class to fields. These can be read accesses (e.g. return this.example) or write accesses (e.g. this.example = example)

See Also:

• getAccessesFromSelf()
• getCodeUnitAccessesFromSelf()
• getCodeUnitCallsFromSelf()
• getConstructorCallsFromSelf()
• getMethodCallsFromSelf()
• getCodeUnitReferencesFromSelf()
• getConstructorReferencesFromSelf()
• getMethodReferencesFromSelf()

getCodeUnitAccessesFromSelf

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

Returns:

All access of this class to other code units. This can be calls to methods/constructors (e.g. someExample.call()) or references of methods/constructors (e.g. SomeExample::call)

See Also:

• getAccessesFromSelf()
• getFieldAccessesFromSelf()
• getCodeUnitCallsFromSelf()
• getConstructorCallsFromSelf()
• getMethodCallsFromSelf()
• getCodeUnitReferencesFromSelf()
• getConstructorReferencesFromSelf()
• getMethodReferencesFromSelf()

getCodeUnitCallsFromSelf

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

Returns all calls of this class to methods or constructors.

See Also:

• getAccessesFromSelf()
• getFieldAccessesFromSelf()
• getCodeUnitAccessesFromSelf()
• getConstructorCallsFromSelf()
• getMethodCallsFromSelf()
• getCodeUnitReferencesFromSelf()
• getConstructorReferencesFromSelf()
• getMethodReferencesFromSelf()

getMethodCallsFromSelf

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

Returns:

All method calls (e.g. a call to SomeExample.someMethod())

See Also:

• getAccessesFromSelf()
• getFieldAccessesFromSelf()
• getCodeUnitAccessesFromSelf()
• getCodeUnitCallsFromSelf()
• getConstructorCallsFromSelf()
• getCodeUnitReferencesFromSelf()
• getConstructorReferencesFromSelf()
• getMethodReferencesFromSelf()

getConstructorCallsFromSelf

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

Returns:

All constructor calls (e.g. a call to SomeExample())

See Also:

• getAccessesFromSelf()
• getFieldAccessesFromSelf()
• getCodeUnitAccessesFromSelf()
• getCodeUnitCallsFromSelf()
• getMethodCallsFromSelf()
• getCodeUnitReferencesFromSelf()
• getConstructorReferencesFromSelf()
• getMethodReferencesFromSelf()

getCodeUnitReferencesFromSelf

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

Returns:

All references of this class to method or constructor references.

See Also:

• getAccessesFromSelf()
• getFieldAccessesFromSelf()
• getCodeUnitAccessesFromSelf()
• getCodeUnitCallsFromSelf()
• getConstructorCallsFromSelf()
• getMethodCallsFromSelf()
• getConstructorReferencesFromSelf()
• getMethodReferencesFromSelf()

getMethodReferencesFromSelf

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

Returns:

All method references (e.g. SomeExample::someMethod)

See Also:

• getAccessesFromSelf()
• getFieldAccessesFromSelf()
• getCodeUnitAccessesFromSelf()
• getCodeUnitCallsFromSelf()
• getConstructorCallsFromSelf()
• getMethodCallsFromSelf()
• getCodeUnitReferencesFromSelf()
• getConstructorReferencesFromSelf()

getConstructorReferencesFromSelf

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

Returns:

All constructor references (e.g. SomeExample::new)

See Also:

• getAccessesFromSelf()
• getFieldAccessesFromSelf()
• getCodeUnitAccessesFromSelf()
• getCodeUnitCallsFromSelf()
• getConstructorCallsFromSelf()
• getMethodCallsFromSelf()
• getCodeUnitReferencesFromSelf()
• getMethodReferencesFromSelf()

getDirectDependenciesFromSelf

@PublicAPI(usage=ACCESS)
public Set<Dependency> getDirectDependenciesFromSelf()

Returns:

All dependencies originating directly from this class (i.e. where this class is the origin). For further details about dependencies refer to Dependency.

getTransitiveDependenciesFromSelf

@PublicAPI(usage=ACCESS)
public Set<Dependency> getTransitiveDependenciesFromSelf()

Returns the transitive closure of all dependencies originating from this class, i.e. its direct dependencies and the dependencies from all imported target classes.

Returns:

all transitive dependencies (including direct dependencies) from this class

See Also:

• getDirectDependenciesFromSelf()

getDirectDependenciesToSelf

@PublicAPI(usage=ACCESS)
public Set<Dependency> getDirectDependenciesToSelf()

Like getDirectDependenciesFromSelf(), but instead returns all dependencies where this class is target.

Returns:

Dependencies where this class is the target.

getFieldAccessesToSelf

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

getCodeUnitAccessesToSelf

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

Like getCodeUnitAccessesFromSelf() but this class is target instead of origin.

getCodeUnitCallsToSelf

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

Like getCodeUnitCallsFromSelf() but this class is target instead of origin.

getCodeUnitReferencesToSelf

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

Like getCodeUnitReferencesFromSelf() but this class is target instead of origin.

getMethodCallsToSelf

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

Like getMethodCallsFromSelf() but this class is target instead of origin.

getMethodReferencesToSelf

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

Like getMethodReferencesFromSelf() but this class is target instead of origin.

getConstructorCallsToSelf

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

Like getConstructorCallsFromSelf() but this class is target instead of origin.

getConstructorReferencesToSelf

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

Like getConstructorReferencesFromSelf() but this class is target instead of origin.

getAccessesToSelf

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

Like getAccessesFromSelf() but this class is target instead of origin.

getFieldsWithTypeOfSelf

@PublicAPI(usage=ACCESS)
public Set<JavaField> getFieldsWithTypeOfSelf()

Returns:

Fields of all imported classes that have the type of this class.

getMethodsWithParameterTypeOfSelf

@PublicAPI(usage=ACCESS)
public Set<JavaMethod> getMethodsWithParameterTypeOfSelf()

Returns:

Methods of all imported classes that have a parameter type of this class.

getMethodsWithReturnTypeOfSelf

@PublicAPI(usage=ACCESS)
public Set<JavaMethod> getMethodsWithReturnTypeOfSelf()

Returns:

Methods of all imported classes that have a return type of this class.

getMethodThrowsDeclarationsWithTypeOfSelf

@PublicAPI(usage=ACCESS)
public Set<ThrowsDeclaration<JavaMethod>> getMethodThrowsDeclarationsWithTypeOfSelf()

Returns:

ThrowsDeclarations of all imported classes that have the type of this class.

getConstructorsWithParameterTypeOfSelf

@PublicAPI(usage=ACCESS)
public Set<JavaConstructor> getConstructorsWithParameterTypeOfSelf()

Returns:

Constructors of all imported classes that have a parameter type of this class.

getConstructorsWithThrowsDeclarationTypeOfSelf

@PublicAPI(usage=ACCESS)
public Set<ThrowsDeclaration<JavaConstructor>> getConstructorsWithThrowsDeclarationTypeOfSelf()

Returns:

ThrowsDeclarations of all imported classes that have the type of this class.

getAnnotationsWithTypeOfSelf

@PublicAPI(usage=ACCESS)
public Set<JavaAnnotation<?>> getAnnotationsWithTypeOfSelf()

Returns:

All imported JavaAnnotations that have the annotation type of this class.

getAnnotationsWithParameterTypeOfSelf

@PublicAPI(usage=ACCESS)
public Set<JavaAnnotation<?>> getAnnotationsWithParameterTypeOfSelf()

Returns:

All imported JavaAnnotations that have a parameter with type of this class.

getInstanceofChecksWithTypeOfSelf

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

Returns:

All imported InstanceofChecks that check if another class is an instance of this class.

isFullyImported

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

Returns:

Whether this class has been fully imported, including all dependencies.
Classes that are only transitively imported are not necessarily fully imported.

Suppose you only import a class Foo that calls a method of class Bar. Then Bar is, as a dependency of the fully imported class Foo, only transitively imported.

isEquivalentTo

@PublicAPI(usage=ACCESS)
public boolean isEquivalentTo(Class<?> clazz)

Parameters:

clazz - An arbitrary type

Returns:

true, if this JavaClass represents the same class as the supplied Class, otherwise false

isAssignableFrom

@PublicAPI(usage=ACCESS)
public boolean isAssignableFrom(Class<?> type)

isAssignableFrom

@PublicAPI(usage=ACCESS)
public boolean isAssignableFrom(String typeName)

isAssignableFrom

@PublicAPI(usage=ACCESS)
public boolean isAssignableFrom(DescribedPredicate<? super JavaClass> predicate)

isAssignableTo

@PublicAPI(usage=ACCESS)
public boolean isAssignableTo(Class<?> type)

isAssignableTo

@PublicAPI(usage=ACCESS)
public boolean isAssignableTo(String typeName)

isAssignableTo

@PublicAPI(usage=ACCESS)
public boolean isAssignableTo(DescribedPredicate<? super JavaClass> predicate)

reflect

@PublicAPI(usage=ACCESS)
public Class<?> reflect()

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

Returns:

The Class equivalent to this JavaClass

toString

public String toString()

Overrides:

toString in class Object

getThrowsDeclarations

@PublicAPI(usage=ACCESS)
public Set<ThrowsDeclaration<? extends JavaCodeUnit>> getThrowsDeclarations()

Returns:

all throws declarations on any method or constructor of this class (e.g. void method() throws SomeException)