java.lang.Object

com.tngtech.archunit.core.domain.JavaClass

All Implemented Interfaces:: HasDescription, JavaType, CanBeAnnotated, HasAnnotations<JavaClass>, HasModifiers, HasName, HasName.AndFullName, HasSourceCodeLocation, HasTypeParameters<JavaClass>

public class JavaClass
extends java.lang.Object
implements JavaType, HasName.AndFullName, HasTypeParameters<JavaClass>, HasAnnotations<JavaClass>, HasModifiers, HasSourceCodeLocation

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class JavaClass.Functions

static class JavaClass.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
`java.util.Set<JavaAccess<?>>`	`getAccessesFromSelf()`
`java.util.Set<JavaAccess<?>>`	`getAccessesToSelf()`
`java.util.Set<JavaAccess<?>>`	`getAllAccessesFromSelf()`
`java.util.Set<JavaClass>`	`getAllClassesSelfIsAssignableTo()`
`java.util.Set<JavaConstructor>`	`getAllConstructors()`
`java.util.Set<JavaField>`	`getAllFields()`
`java.util.Set<JavaMember>`	`getAllMembers()`
`java.util.Set<JavaMethod>`	`getAllMethods()`
`java.util.Set<JavaClass>`	`getAllRawInterfaces()`
`java.util.List<JavaClass>`	`getAllRawSuperclasses()`
`java.util.Set<JavaClass>`	`getAllSubclasses()`
`java.util.Set<JavaClass>`	`getAllSubClasses()`	Deprecated. Use `getAllSubclasses()` instead.
`java.util.List<JavaClass>`	`getAllSuperClasses()`	Deprecated. Use `getAllRawSuperclasses()` instead.
`<A extends java.lang.annotation.Annotation> A`	`getAnnotationOfType(java.lang.Class<A> type)`
`JavaAnnotation<JavaClass>`	`getAnnotationOfType(java.lang.String typeName)`
`java.util.Set<JavaAnnotation<JavaClass>>`	`getAnnotations()`
`java.util.Set<JavaAnnotation<?>>`	`getAnnotationsWithParameterTypeOfSelf()`
`java.util.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.
`java.util.Set<JavaCall<?>>`	`getCallsFromSelf()`	Returns all calls of this class to methods or constructors.
`java.util.List<JavaClass>`	`getClassHierarchy()`
`java.util.Set<JavaCodeUnit>`	`getCodeUnits()`
`JavaCodeUnit`	`getCodeUnitWithParameterTypeNames(java.lang.String name, java.lang.String... parameters)`	Same as `getCodeUnitWithParameterTypes(String, Class[])`, but with parameter signature specified as full class names
`JavaCodeUnit`	`getCodeUnitWithParameterTypeNames(java.lang.String name, java.util.List<java.lang.String> parameters)`
`JavaCodeUnit`	`getCodeUnitWithParameterTypes(java.lang.String name, java.lang.Class<?>... parameters)`
`JavaCodeUnit`	`getCodeUnitWithParameterTypes(java.lang.String name, java.util.List<java.lang.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(java.lang.Class<?>... parameters)`
`JavaConstructor`	`getConstructor(java.lang.String... parameters)`	Same as `getConstructor(Class[])`, but with parameter signature specified as full class names.
`java.util.Set<JavaConstructorCall>`	`getConstructorCallsFromSelf()`
`java.util.Set<JavaConstructorCall>`	`getConstructorCallsToSelf()`
`java.util.Set<JavaConstructor>`	`getConstructors()`
`java.util.Set<JavaConstructor>`	`getConstructorsWithParameterTypeOfSelf()`
`java.util.Set<ThrowsDeclaration<JavaConstructor>>`	`getConstructorsWithThrowsDeclarationTypeOfSelf()`
`java.lang.String`	`getDescription()`
`java.util.Set<Dependency>`	`getDirectDependenciesFromSelf()`	Returns all dependencies originating directly from this class (i.e.
`java.util.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(java.lang.String name)`
`java.util.Set<JavaEnumConstant>`	`getEnumConstants()`
`JavaField`	`getField(java.lang.String name)`
`java.util.Set<JavaFieldAccess>`	`getFieldAccessesFromSelf()`
`java.util.Set<JavaFieldAccess>`	`getFieldAccessesToSelf()`
`java.util.Set<JavaField>`	`getFields()`
`java.util.Set<JavaField>`	`getFieldsWithTypeOfSelf()`
`java.lang.String`	`getFullName()`
`java.util.Set<InstanceofCheck>`	`getInstanceofChecksWithTypeOfSelf()`
`java.util.Set<JavaType>`	`getInterfaces()`
`java.util.Set<JavaMember>`	`getMembers()`
`JavaMethod`	`getMethod(java.lang.String name)`
`JavaMethod`	`getMethod(java.lang.String name, java.lang.Class<?>... parameters)`
`JavaMethod`	`getMethod(java.lang.String name, java.lang.String... parameters)`	Same as `getMethod(String, Class[])`, but with parameter signature specified as fully qualified class names.
`java.util.Set<JavaMethodCall>`	`getMethodCallsFromSelf()`
`java.util.Set<JavaMethodCall>`	`getMethodCallsToSelf()`
`java.util.Set<JavaMethod>`	`getMethods()`
`java.util.Set<JavaMethod>`	`getMethodsWithParameterTypeOfSelf()`
`java.util.Set<JavaMethod>`	`getMethodsWithReturnTypeOfSelf()`
`java.util.Set<ThrowsDeclaration<JavaMethod>>`	`getMethodThrowsDeclarationsWithTypeOfSelf()`
`java.util.Set<JavaModifier>`	`getModifiers()`
`java.lang.String`	`getName()`
`JavaPackage`	`getPackage()`
`java.lang.String`	`getPackageName()`
`java.util.Set<JavaClass>`	`getRawInterfaces()`
`Optional<JavaClass>`	`getRawSuperclass()`
`java.util.Set<ReferencedClassObject>`	`getReferencedClassObjects()`
`java.lang.String`	`getSimpleName()`
`Optional<Source>`	`getSource()`
`SourceCodeLocation`	`getSourceCodeLocation()`
`Optional<JavaStaticInitializer>`	`getStaticInitializer()`
`java.util.Set<JavaClass>`	`getSubclasses()`
`java.util.Set<JavaClass>`	`getSubClasses()`	Deprecated. Use `getSubclasses()` instead.
`Optional<JavaType>`	`getSuperclass()`
`Optional<JavaClass>`	`getSuperClass()`	Deprecated. Use `getRawSuperclass()` instead
`java.util.Set<Dependency>`	`getTransitiveDependenciesFromSelf()`	Returns the transitive closure of all dependencies originating from this class, i.e.
`java.util.List<JavaTypeVariable<JavaClass>>`	`getTypeParameters()`
`boolean`	`isAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate)`
`boolean`	`isAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)`
`boolean`	`isAnnotatedWith(java.lang.String annotationTypeName)`
`boolean`	`isAnnotation()`
`boolean`	`isAnonymous()`	Deprecated. use `isAnonymousClass()` instead
`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(java.lang.Class<?> type)`
`boolean`	`isAssignableFrom(java.lang.String typeName)`
`boolean`	`isAssignableTo(DescribedPredicate<? super JavaClass> predicate)`
`boolean`	`isAssignableTo(java.lang.Class<?> type)`
`boolean`	`isAssignableTo(java.lang.String typeName)`
`boolean`	`isEnum()`
`boolean`	`isEquivalentTo(java.lang.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)`
`boolean`	`isMetaAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> type)`
`boolean`	`isMetaAnnotatedWith(java.lang.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.
`static java.util.List<java.lang.String>`	`namesOf(java.lang.Class<?>... paramTypes)`	Deprecated. use `Formatters.formatNamesOf(Class[])` instead
`static java.util.List<java.lang.String>`	`namesOf(java.lang.Iterable<java.lang.Class<?>> paramTypes)`	Deprecated. use `Formatters.formatNamesOf(Iterable)` instead
`java.lang.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).
`java.lang.String`	`toString()`
`<A extends java.lang.annotation.Annotation> Optional<A>`	`tryGetAnnotationOfType(java.lang.Class<A> type)`
`Optional<JavaAnnotation<JavaClass>>`	`tryGetAnnotationOfType(java.lang.String typeName)`	Same as `tryGetAnnotationOfType(Class)`, but takes the type name.
`Optional<JavaCodeUnit>`	`tryGetCodeUnitWithParameterTypeNames(java.lang.String name, java.util.List<java.lang.String> parameters)`	Same as `getCodeUnitWithParameterTypeNames(String, List)`, but will return `Optional.absent()` if there is no such `JavaCodeUnit`.
`Optional<JavaCodeUnit>`	`tryGetCodeUnitWithParameterTypes(java.lang.String name, java.util.List<java.lang.Class<?>> parameters)`	Same as `getCodeUnitWithParameterTypes(String, List)`, but will return `Optional.absent()` if there is no such `JavaCodeUnit`.
`Optional<JavaClass>`	`tryGetComponentType()`	Returns the component type of this class, if this class is an array, otherwise `Optional.absent()`.
`Optional<JavaConstructor>`	`tryGetConstructor()`
`Optional<JavaConstructor>`	`tryGetConstructor(java.lang.Class<?>... parameters)`
`Optional<JavaConstructor>`	`tryGetConstructor(java.lang.String... parameters)`	Same as `tryGetConstructor(Class[])`, but with parameter signature specified as fully qualified class names.
`Optional<JavaEnumConstant>`	`tryGetEnumConstant(java.lang.String name)`
`Optional<JavaField>`	`tryGetField(java.lang.String name)`
`Optional<JavaMethod>`	`tryGetMethod(java.lang.String name)`
`Optional<JavaMethod>`	`tryGetMethod(java.lang.String name, java.lang.Class<?>... parameters)`
`Optional<JavaMethod>`	`tryGetMethod(java.lang.String name, java.lang.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 java.lang.String getDescription()
  
  Specified by:
  
  getDescription in interface HasDescription
- getName
  
  @PublicAPI(usage=ACCESS) public java.lang.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 java.lang.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 java.lang.String getSimpleName()
- getPackage
  
  @PublicAPI(usage=ACCESS) public JavaPackage getPackage()
- getPackageName
  
  @PublicAPI(usage=ACCESS) public java.lang.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(java.lang.String name)
- getEnumConstant
  
  @PublicAPI(usage=ACCESS) public JavaEnumConstant getEnumConstant(java.lang.String name)
- getEnumConstants
  
  @PublicAPI(usage=ACCESS) public java.util.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:
  
  java.lang.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.absent(). 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.absent()
- 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 java.util.Set<JavaModifier> getModifiers()
  
  Specified by:
  
  getModifiers in interface HasModifiers
- isAnnotatedWith
  
  @PublicAPI(usage=ACCESS) public boolean isAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
  
  Specified by:
  
  isAnnotatedWith in interface CanBeAnnotated
- isAnnotatedWith
  
  @PublicAPI(usage=ACCESS) public boolean isAnnotatedWith(java.lang.String annotationTypeName)
  
  Specified by:
  
  isAnnotatedWith in interface CanBeAnnotated
- isAnnotatedWith
  
  @PublicAPI(usage=ACCESS) public boolean isAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate)
  
  Specified by:
  
  isAnnotatedWith in interface CanBeAnnotated
- isMetaAnnotatedWith
  
  @PublicAPI(usage=ACCESS) public boolean isMetaAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> type)
  
  Specified by:
  
  isMetaAnnotatedWith in interface CanBeAnnotated
- isMetaAnnotatedWith
  
  @PublicAPI(usage=ACCESS) public boolean isMetaAnnotatedWith(java.lang.String typeName)
  
  Specified by:
  
  isMetaAnnotatedWith in interface CanBeAnnotated
- isMetaAnnotatedWith
  
  @PublicAPI(usage=ACCESS) public boolean isMetaAnnotatedWith(DescribedPredicate<? super JavaAnnotation<?>> predicate)
  
  Specified by:
  
  isMetaAnnotatedWith in interface CanBeAnnotated
- getAnnotationOfType
  
  @PublicAPI(usage=ACCESS) public <A extends java.lang.annotation.Annotation> A getAnnotationOfType(java.lang.Class<A> type)
  
  Specified by:
  
  getAnnotationOfType in interface HasAnnotations<JavaClass>
  
  Parameters:
  
  type - A given annotation type to match JavaAnnotations against
  
  Returns:
  
  An Annotation of the given annotation type
  
  Throws:
  
  java.lang.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(java.lang.String typeName)
  
  Specified by:
  
  getAnnotationOfType in interface HasAnnotations<JavaClass>
- getAnnotations
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaAnnotation<JavaClass>> getAnnotations()
  
  Specified by:
  
  getAnnotations in interface HasAnnotations<JavaClass>
- tryGetAnnotationOfType
  
  @PublicAPI(usage=ACCESS) public <A extends java.lang.annotation.Annotation> Optional<A> tryGetAnnotationOfType(java.lang.Class<A> type)
  
  Specified by:
  
  tryGetAnnotationOfType in interface HasAnnotations<JavaClass>
  
  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(java.lang.String typeName)
  
  Same as tryGetAnnotationOfType(Class), but takes the type name.
  
  Specified by:
  
  tryGetAnnotationOfType in interface HasAnnotations<JavaClass>
- getTypeParameters
  
  @PublicAPI(usage=ACCESS) public java.util.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.
- getReferencedClassObjects
  
  @PublicAPI(usage=ACCESS) public java.util.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
- getRawSuperclass
  
  @PublicAPI(usage=ACCESS) public Optional<JavaClass> getRawSuperclass()
- getSuperclass
  
  @PublicAPI(usage=ACCESS) public Optional<JavaType> getSuperclass()
- getSuperClass
  
  @Deprecated @PublicAPI(usage=ACCESS) public Optional<JavaClass> getSuperClass()
  
  Deprecated.
  Use getRawSuperclass() instead
- getClassHierarchy
  
  @PublicAPI(usage=ACCESS) public java.util.List<JavaClass> getClassHierarchy()
  
  Returns:
  
  The complete class hierarchy, i.e. the class itself and the result of getAllRawSuperclasses()
- getAllRawSuperclasses
  
  @PublicAPI(usage=ACCESS) public java.util.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.
- getAllSuperClasses
  
  @Deprecated @PublicAPI(usage=ACCESS) public java.util.List<JavaClass> getAllSuperClasses()
  
  Deprecated.
  Use getAllRawSuperclasses() instead.
- getSubclasses
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaClass> getSubclasses()
- getSubClasses
  
  @Deprecated @PublicAPI(usage=ACCESS) public java.util.Set<JavaClass> getSubClasses()
  
  Deprecated.
  Use getSubclasses() instead.
- getInterfaces
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaType> getInterfaces()
- getRawInterfaces
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaClass> getRawInterfaces()
- getAllRawInterfaces
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaClass> getAllRawInterfaces()
- getAllClassesSelfIsAssignableTo
  
  @PublicAPI(usage=ACCESS) public java.util.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.absent().
  
  Take for example
  class OuterClass { class InnerClass{ } }
  Then InnerClass.getEnclosingClass() would return Optional.of(OuterClass). While OuterClass.getEnclosingClass() would return Optional.absent().
- 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.absent().
  
  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.absent(), since they are not defined within the context of a JavaCodeUnit.
- getAllSubclasses
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaClass> getAllSubclasses()
- getAllSubClasses
  
  @Deprecated @PublicAPI(usage=ACCESS) public java.util.Set<JavaClass> getAllSubClasses()
  
  Deprecated.
  Use getAllSubclasses() instead.
- getMembers
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaMember> getMembers()
- getAllMembers
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaMember> getAllMembers()
- getFields
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaField> getFields()
- getAllFields
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaField> getAllFields()
- getField
  
  @PublicAPI(usage=ACCESS) public JavaField getField(java.lang.String name)
  
  Returns:
  
  The field with the given name.
  
  Throws:
  
  java.lang.IllegalArgumentException - If this class does not have such a field.
- tryGetField
  
  @PublicAPI(usage=ACCESS) public Optional<JavaField> tryGetField(java.lang.String name)
  
  Returns:
  
  The field with the given name, if this class has such a field, otherwise Optional.absent().
- getCodeUnits
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaCodeUnit> getCodeUnits()
- getCodeUnitWithParameterTypes
  
  @PublicAPI(usage=ACCESS) public JavaCodeUnit getCodeUnitWithParameterTypes(java.lang.String name, java.lang.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(java.lang.String name, java.lang.String... parameters)
  
  Same as getCodeUnitWithParameterTypes(String, Class[]), but with parameter signature specified as full class names
- getCodeUnitWithParameterTypes
  
  @PublicAPI(usage=ACCESS) public JavaCodeUnit getCodeUnitWithParameterTypes(java.lang.String name, java.util.List<java.lang.Class<?>> parameters)
  
  See Also:
  
  getCodeUnitWithParameterTypes(String, Class[])
- tryGetCodeUnitWithParameterTypes
  
  @PublicAPI(usage=ACCESS) public Optional<JavaCodeUnit> tryGetCodeUnitWithParameterTypes(java.lang.String name, java.util.List<java.lang.Class<?>> parameters)
  
  Same as getCodeUnitWithParameterTypes(String, List), but will return Optional.absent() if there is no such JavaCodeUnit.
- getCodeUnitWithParameterTypeNames
  
  @PublicAPI(usage=ACCESS) public JavaCodeUnit getCodeUnitWithParameterTypeNames(java.lang.String name, java.util.List<java.lang.String> parameters)
  
  See Also:
  
  getCodeUnitWithParameterTypeNames(String, String...)
- tryGetCodeUnitWithParameterTypeNames
  
  @PublicAPI(usage=ACCESS) public Optional<JavaCodeUnit> tryGetCodeUnitWithParameterTypeNames(java.lang.String name, java.util.List<java.lang.String> parameters)
  
  Same as getCodeUnitWithParameterTypeNames(String, List), but will return Optional.absent() if there is no such JavaCodeUnit.
- getMethod
  
  @PublicAPI(usage=ACCESS) public JavaMethod getMethod(java.lang.String name)
  
  Returns:
  
  The method with the given name and with zero parameters.
  
  Throws:
  
  java.lang.IllegalArgumentException - If this class does not have such a method.
- getMethod
  
  @PublicAPI(usage=ACCESS) public JavaMethod getMethod(java.lang.String name, java.lang.Class<?>... parameters)
  
  Returns:
  
  The method with the given name and the given parameter types.
  
  Throws:
  
  java.lang.IllegalArgumentException - If this class does not have such a method.
- getMethod
  
  @PublicAPI(usage=ACCESS) public JavaMethod getMethod(java.lang.String name, java.lang.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(java.lang.String name)
  
  Returns:
  
  The method with the given name and with zero parameters, if this class has such a method, otherwise Optional.absent().
- tryGetMethod
  
  @PublicAPI(usage=ACCESS) public Optional<JavaMethod> tryGetMethod(java.lang.String name, java.lang.Class<?>... parameters)
  
  Returns:
  
  The method with the given name and the given parameter types, if this class has such a method, otherwise Optional.absent().
- tryGetMethod
  
  @PublicAPI(usage=ACCESS) public Optional<JavaMethod> tryGetMethod(java.lang.String name, java.lang.String... parameters)
  
  Same as tryGetMethod(String, Class[]), but with parameter signature specified as fully qualified class names.
- getMethods
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaMethod> getMethods()
- getAllMethods
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaMethod> getAllMethods()
- getConstructor
  
  @PublicAPI(usage=ACCESS) public JavaConstructor getConstructor()
  
  Returns:
  
  The constructor with zero parameters.
  
  Throws:
  
  java.lang.IllegalArgumentException - If this class does not have such a constructor.
- getConstructor
  
  @PublicAPI(usage=ACCESS) public JavaConstructor getConstructor(java.lang.Class<?>... parameters)
  
  Returns:
  
  The constructor with the given parameter types.
  
  Throws:
  
  java.lang.IllegalArgumentException - If this class does not have a constructor with the given parameter types.
- getConstructor
  
  @PublicAPI(usage=ACCESS) public JavaConstructor getConstructor(java.lang.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.absent().
- tryGetConstructor
  
  @PublicAPI(usage=ACCESS) public Optional<JavaConstructor> tryGetConstructor(java.lang.Class<?>... parameters)
  
  Returns:
  
  The constructor with the given parameter types, if this class has such a constructor, otherwise Optional.absent().
- tryGetConstructor
  
  @PublicAPI(usage=ACCESS) public Optional<JavaConstructor> tryGetConstructor(java.lang.String... parameters)
  
  Same as tryGetConstructor(Class[]), but with parameter signature specified as fully qualified class names.
- getConstructors
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaConstructor> getConstructors()
- getAllConstructors
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaConstructor> getAllConstructors()
- getStaticInitializer
  
  @PublicAPI(usage=ACCESS) public Optional<JavaStaticInitializer> getStaticInitializer()
- getAccessesFromSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaAccess<?>> getAccessesFromSelf()
- getAllAccessesFromSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaAccess<?>> getAllAccessesFromSelf()
  
  Returns:
  
  Set of all JavaAccess in the class hierarchy, as opposed to the accesses this class directly performs.
- getFieldAccessesFromSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaFieldAccess> getFieldAccessesFromSelf()
- getCallsFromSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaCall<?>> getCallsFromSelf()
  
  Returns all calls of this class to methods or constructors.
  
  See Also:
  
  getMethodCallsFromSelf(), getConstructorCallsFromSelf()
- getMethodCallsFromSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaMethodCall> getMethodCallsFromSelf()
- getConstructorCallsFromSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaConstructorCall> getConstructorCallsFromSelf()
- getDirectDependenciesFromSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<Dependency> getDirectDependenciesFromSelf()
  Returns all dependencies originating directly from this class (i.e. not just from a superclass), where a dependency can be
  
  field access
  
  method call
  
  constructor call
  
  extending a class
  
  implementing an interface
  
  referencing in throws declaration
  Returns:
  
  All dependencies originating directly from this class (i.e. where this class is the origin)
- getTransitiveDependenciesFromSelf
  
  @PublicAPI(usage=ACCESS) public java.util.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 java.util.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 java.util.Set<JavaFieldAccess> getFieldAccessesToSelf()
- getMethodCallsToSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaMethodCall> getMethodCallsToSelf()
- getConstructorCallsToSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaConstructorCall> getConstructorCallsToSelf()
- getAccessesToSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaAccess<?>> getAccessesToSelf()
- getFieldsWithTypeOfSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaField> getFieldsWithTypeOfSelf()
  
  Returns:
  
  Fields of all imported classes that have the type of this class.
- getMethodsWithParameterTypeOfSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaMethod> getMethodsWithParameterTypeOfSelf()
  
  Returns:
  
  Methods of all imported classes that have a parameter type of this class.
- getMethodsWithReturnTypeOfSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaMethod> getMethodsWithReturnTypeOfSelf()
  
  Returns:
  
  Methods of all imported classes that have a return type of this class.
- getMethodThrowsDeclarationsWithTypeOfSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<ThrowsDeclaration<JavaMethod>> getMethodThrowsDeclarationsWithTypeOfSelf()
  
  Returns:
  
  ThrowsDeclarations of all imported classes that have the type of this class.
- getConstructorsWithParameterTypeOfSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaConstructor> getConstructorsWithParameterTypeOfSelf()
  
  Returns:
  
  Constructors of all imported classes that have a parameter type of this class.
- getConstructorsWithThrowsDeclarationTypeOfSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<ThrowsDeclaration<JavaConstructor>> getConstructorsWithThrowsDeclarationTypeOfSelf()
  
  Returns:
  
  ThrowsDeclarations of all imported classes that have the type of this class.
- getAnnotationsWithTypeOfSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaAnnotation<?>> getAnnotationsWithTypeOfSelf()
  
  Returns:
  
  All imported JavaAnnotations that have the annotation type of this class.
- getAnnotationsWithParameterTypeOfSelf
  
  @PublicAPI(usage=ACCESS) public java.util.Set<JavaAnnotation<?>> getAnnotationsWithParameterTypeOfSelf()
  
  Returns:
  
  All imported JavaAnnotations that have a parameter with type of this class.
- getInstanceofChecksWithTypeOfSelf
  
  @PublicAPI(usage=ACCESS) public java.util.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(java.lang.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(java.lang.Class<?> type)
- isAssignableFrom
  
  @PublicAPI(usage=ACCESS) public boolean isAssignableFrom(java.lang.String typeName)
- isAssignableFrom
  
  @PublicAPI(usage=ACCESS) public boolean isAssignableFrom(DescribedPredicate<? super JavaClass> predicate)
- isAssignableTo
  
  @PublicAPI(usage=ACCESS) public boolean isAssignableTo(java.lang.Class<?> type)
- isAssignableTo
  
  @PublicAPI(usage=ACCESS) public boolean isAssignableTo(java.lang.String typeName)
- isAssignableTo
  
  @PublicAPI(usage=ACCESS) public boolean isAssignableTo(DescribedPredicate<? super JavaClass> predicate)
- reflect
  
  @PublicAPI(usage=ACCESS) public java.lang.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 java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object
- namesOf
  
  @Deprecated @PublicAPI(usage=ACCESS) public static java.util.List<java.lang.String> namesOf(java.lang.Class<?>... paramTypes)
  
  Deprecated.
  use Formatters.formatNamesOf(Class[]) instead
- namesOf
  
  @Deprecated @PublicAPI(usage=ACCESS) public static java.util.List<java.lang.String> namesOf(java.lang.Iterable<java.lang.Class<?>> paramTypes)
  
  Deprecated.
  use Formatters.formatNamesOf(Iterable) instead
- isAnonymous
  
  @Deprecated @PublicAPI(usage=ACCESS) public boolean isAnonymous()
  
  Deprecated.
  use isAnonymousClass() instead

Modifier and Type	Class	Description
`static class`	`JavaClass.Functions`
`static class`	`JavaClass.Predicates`

Class JavaClass

Nested Class Summary

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

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

Method Summary

Methods inherited from class java.lang.Object

Method Details

getSource

getSourceCodeLocation

getDescription

getName

getFullName

getSimpleName

getPackage

getPackageName

isPrimitive

isInterface

isEnum

isAnnotation

isRecord

tryGetEnumConstant

getEnumConstant

getEnumConstants

isArray

getComponentType

tryGetComponentType

getBaseComponentType

isTopLevelClass

isNestedClass

isMemberClass

isInnerClass

isLocalClass

isAnonymousClass

getModifiers

isAnnotatedWith

isAnnotatedWith

isAnnotatedWith

isMetaAnnotatedWith

isMetaAnnotatedWith

isMetaAnnotatedWith

getAnnotationOfType

getAnnotationOfType

getAnnotations

tryGetAnnotationOfType

tryGetAnnotationOfType

getTypeParameters

getReferencedClassObjects

toErasure

getRawSuperclass

getSuperclass

getSuperClass

getClassHierarchy

getAllRawSuperclasses

getAllSuperClasses

getSubclasses

getSubClasses

getInterfaces

getRawInterfaces

getAllRawInterfaces

getAllClassesSelfIsAssignableTo

getEnclosingClass

getEnclosingCodeUnit

getAllSubclasses

getAllSubClasses

getMembers

getAllMembers

getFields

getAllFields

getField

tryGetField

getCodeUnits

getCodeUnitWithParameterTypes

getCodeUnitWithParameterTypeNames

getCodeUnitWithParameterTypes

tryGetCodeUnitWithParameterTypes

getCodeUnitWithParameterTypeNames

tryGetCodeUnitWithParameterTypeNames

getMethod

getMethod

getMethod