OpenJDK 1.23 · java.lang.Class · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	Class.AnnotationData
private static class	Class.Atomic Atomic operations support.
private static class	Class.EnclosingMethodInfo
private static class	Class.ReflectionData<T> Reflection support.

Modifier and Type	Field and Description
private static ProtectionDomain	allPermDomain protection domain returned when the internal domain is null
private static final int	ANNOTATION
private transient volatile Class.AnnotationData	annotationData
private transient volatile AnnotationType	annotationType
private transient volatile Constructor<T>	cachedConstructor
private transient Object	classData
private final ClassLoader	classLoader
private transient volatile int	classRedefinedCount
pack-priv transient ClassValue.ClassValueMap	classValueMap
private final Class<?>	componentType
private static final Class<?>[]	EMPTY_CLASS_ARRAY
private static final int	ENUM
private transient volatile Map<String, T>	enumConstantDirectory
private transient volatile T[]	enumConstants
private transient volatile ClassRepository	genericInfo
private transient Module	module
private transient String	name
private transient String	packageName
private transient volatile SoftReference<Class.ReflectionData<T>>	reflectionData
private static ReflectionFactory	reflectionFactory
private static final ObjectStreamField[]	serialPersistentFields Class Class is special cased within the Serialization Stream Protocol.
private static final long	serialVersionUID use serialVersionUID from JDK 1.1 for interoperability
private static final int	SYNTHETIC

Access	Constructor and Description
private	Class(ClassLoader loader, Class<?> arrayComponentType)

Method Summary

Modifier and Type	Method and Description
public Set<AccessFlag>	Returns: an unmodifiable set of the access flags for this class, possibly empty accessFlags() Returns an unmodifiable set of the access flags for this class, possibly empty.
private static void	addAll(Collection<Field> c, Field[] o)
private void	addSealingInfo(int modifiers, StringBuilder sb)
private Class.AnnotationData	annotationData()
private static boolean	arrayContentsEq(Object[] a1, Object[] a2)
public Class<?>	Returns: a `Class` describing the array type arrayType() Implements java.lang.invoke.TypeDescriptor.OfField.arrayType. Returns a `Class` for an array type whose component type is described by this Class.
public < the type to cast this `Class` object to U> Class<? extends U>	Returns: this `Class` object, cast to represent a subclass of the specified class object. asSubclass(Class<U> the class of the type to cast this `Class` object to clazz) Casts this `Class` object to represent a subclass of the class represented by the specified class object.
private String	cannotCastMsg(Object obj)
pack-priv boolean	casAnnotationType(AnnotationType oldType, AnnotationType newType)
public T	Returns: the object after casting, or null if obj is null cast(Object the object to be cast obj) Casts an object to the class or interface represented by this `Class` object.
private void	checkMemberAccess(SecurityManager sm, int which, Class<?> caller, boolean checkProxyInterfaces) References Deprecated `SecurityManager` is deprecated or references (maybe indirectly) at least one deprecated element.
private void	checkPackageAccess(SecurityManager sm, final ClassLoader ccl, boolean checkProxyInterfaces) References Deprecated `SecurityManager` is deprecated or references (maybe indirectly) at least one deprecated element.
private static void	checkPackageAccessForPermittedSubclasses(SecurityManager sm, final ClassLoader ccl, Class<?>[] subClasses) References Deprecated `SecurityManager` is deprecated or references (maybe indirectly) at least one deprecated element.
public Class<?>	Returns: a `Class` describing the component type, or `null` if this `Class` does not describe an array type componentType() Implements java.lang.invoke.TypeDescriptor.OfField.componentType. Returns the component type of this `Class`, if it describes an array type, or `null` otherwise.
private static <U> Constructor<U>[]	copyConstructors(Constructor<U>[] arg)
private static Field[]	copyFields(Field[] arg)
private static Method[]	copyMethods(Method[] arg)
private Class.AnnotationData	createAnnotationData(int classRedefinedCount)
public Optional<ClassDesc>	Returns: An `Optional` containing the resulting nominal descriptor, or an empty `Optional` if one cannot be constructed. describeConstable() Implements java.lang.constant.Constable.describeConstable. Returns a nominal descriptor for this instance, if one can be constructed, or an empty `Optional` if one cannot be.
public String	Returns: the descriptor string for this `Class` object descriptorString() Implements java.lang.invoke.TypeDescriptor.descriptorString. Returns the descriptor string of the entity (class, interface, array class, primitive type, or `void`) represented by this `Class` object.
public boolean	Returns: the desired assertion status of the specified class. desiredAssertionStatus() Returns the assertion status that would be assigned to this class if it were to be initialized at the time this method is invoked.
private static native boolean	desiredAssertionStatus0(Class<?> clazz)
private Class<?>	elementType()
pack-priv Map<String, T>	enumConstantDirectory() Returns a map from simple name to enum constant.
pack-priv Method	Returns: the `Method` object for the method found from this class matching the specified name and parameters, or null if not found findMethod(boolean true if only public methods are examined, otherwise all methods publicOnly, String the name of the method name, Class<?>... the parameter array parameterTypes) Returns the most specific `Method` object of this class, super class or interface that have the specified method name and parameter types.
public static Class<?>	Returns: the `Class` object for the class with the specified name. forName(String the binary name of the class or the string representing an array type className) Returns the `Class` object associated with the class or interface with the given string name.
private static Class<?>	forName(String className, Class<?> caller)
public static Class<?>	Returns: class object representing the desired class forName(String the binary name of the class or the string representing an array class name, boolean if `true` the class will be initialized (which implies linking). See Section 12.4 of The Java Language Specification. initialize, ClassLoader class loader from which the class must be loaded loader) Returns the `Class` object associated with the class or interface with the given string name, using the given class loader.
private static Class<?>	forName(String name, boolean initialize, ClassLoader loader, Class<?> caller)
public static Class<?>	Returns: `Class` object of the given name defined in the given module; `null` if not found. forName(Module A module module, String The binary name of the class name) Returns the `Class` with the given binary name in the given module.
private static Class<?>	forName(Module module, String name, Class<?> caller)
private static native Class<?>	forName0(String name, boolean initialize, ClassLoader loader, Class<?> caller) Called after security check for system loader access checks have been made.
public static Class<?>	Returns: the `Class` object associated with the primitive type of the given name forPrimitiveName(String the name of the primitive type to find primitiveName) Returns the `Class` object associated with the primitive type of the given name.
public AnnotatedType[]	Returns: an array representing the superinterfaces getAnnotatedInterfaces() Returns an array of `AnnotatedType` objects that represent the use of types to specify superinterfaces of the entity represented by this `Class` object.
public AnnotatedType	Returns: an object representing the superclass getAnnotatedSuperclass() Returns an `AnnotatedType` object that represents the use of a type to specify the superclass of the entity represented by this `Class` object.
public <A extends Annotation> A	getAnnotation(Class<A> the Class object corresponding to the annotation type annotationClass) Implements java.lang.reflect.AnnotatedElement.getAnnotation. Returns this element's annotation for the specified type if such an annotation is present, else null.
public Annotation[]	getAnnotations() Implements java.lang.reflect.AnnotatedElement.getAnnotations. Returns annotations that are present on this element.
public <A extends Annotation> A[]	getAnnotationsByType(Class<A> the Class object corresponding to the annotation type annotationClass) Overrides default java.lang.reflect.AnnotatedElement.getAnnotationsByType. Returns annotations that are associated with this element.
pack-priv AnnotationType	getAnnotationType()
public String	Returns: the canonical name of the underlying class if it exists, and `null` otherwise. getCanonicalName() Returns the canonical name of the underlying class as defined by The Java Language Specification.
private String	getCanonicalName0()
private int	getClassAccessFlagsRaw()
private native int	getClassAccessFlagsRaw0()
pack-priv Object	getClassData()
public Class<?>[]	Returns: the array of `Class` objects representing the public members of this class getClasses() Returns an array containing `Class` objects representing all the public classes and interfaces that are members of the class represented by this `Class` object.
private int	getClassFileVersion()
private native int	getClassFileVersion0()
public ClassLoader	Returns: the class loader that loaded the class or interface represented by this `Class` object. getClassLoader() Returns the class loader for the class.
pack-priv ClassLoader	getClassLoader0()
public Class<?>	Returns: the `Class` representing the component type of this class if this class is an array getComponentType() Returns the `Class` representing the component type of an array.
pack-priv native ConstantPool	getConstantPool()
public Constructor<T>	Returns: the `Constructor` object of the public constructor that matches the specified `parameterTypes` getConstructor(Class<?>... the parameter array parameterTypes) Returns a `Constructor` object that reflects the specified public constructor of the class represented by this `Class` object.
private Constructor<T>	getConstructor0(Class<?>[] parameterTypes, int which)
public Constructor<?>[]	Returns: the array of `Constructor` objects representing the public constructors of this class getConstructors() Returns an array containing `Constructor` objects reflecting all the public constructors of the class represented by this `Class` object.
public <A extends Annotation> A	getDeclaredAnnotation(Class<A> the Class object corresponding to the annotation type annotationClass) Overrides default java.lang.reflect.AnnotatedElement.getDeclaredAnnotation. Returns this element's annotation for the specified type if such an annotation is directly present, else null.
pack-priv Map<Class<? extends Annotation>, Annotation>	getDeclaredAnnotationMap()
public Annotation[]	getDeclaredAnnotations() Implements java.lang.reflect.AnnotatedElement.getDeclaredAnnotations. Returns annotations that are directly present on this element.
public <A extends Annotation> A[]	getDeclaredAnnotationsByType(Class<A> the Class object corresponding to the annotation type annotationClass) Overrides default java.lang.reflect.AnnotatedElement.getDeclaredAnnotationsByType. Returns this element's annotation(s) for the specified type if such annotations are either directly present or indirectly present.
public Class<?>[]	Returns: the array of `Class` objects representing all the declared members of this class getDeclaredClasses() Returns an array of `Class` objects reflecting all the classes and interfaces declared as members of the class represented by this `Class` object.
private native Class<?>[]	getDeclaredClasses0()
public Constructor<T>	Returns: The `Constructor` object for the constructor with the specified parameter list getDeclaredConstructor(Class<?>... the parameter array parameterTypes) Returns a `Constructor` object that reflects the specified constructor of the class represented by this `Class` object.
public Constructor<?>[]	Returns: the array of `Constructor` objects representing all the declared constructors of this class getDeclaredConstructors() Returns an array of `Constructor` objects reflecting all the constructors implicitly or explicitly declared by the class represented by this `Class` object.
private native Constructor<T>[]	getDeclaredConstructors0(boolean publicOnly)
public Field	Returns: the `Field` object for the specified field in this class getDeclaredField(String the name of the field name) Returns a `Field` object that reflects the specified declared field of the class or interface represented by this `Class` object.
public Field[]	Returns: the array of `Field` objects representing all the declared fields of this class getDeclaredFields() Returns an array of `Field` objects reflecting all the fields declared by the class or interface represented by this `Class` object.
private native Field[]	getDeclaredFields0(boolean publicOnly)
public Method	Returns: the `Method` object for the method of this class matching the specified name and parameters getDeclaredMethod(String the name of the method name, Class<?>... the parameter array parameterTypes) Returns a `Method` object that reflects the specified declared method of the class or interface represented by this `Class` object.
public Method[]	Returns: the array of `Method` objects representing all the declared methods of this class getDeclaredMethods() Returns an array containing `Method` objects reflecting all the declared methods of the class or interface represented by this `Class` object, including public, protected, default (package) access, and private methods, but excluding inherited methods.
private native Method[]	getDeclaredMethods0(boolean publicOnly)
pack-priv List<Method>	Returns: the list of `Method` objects for the public methods of this class matching the specified name and parameters getDeclaredPublicMethods(String the name of the method name, Class<?>... the parameter array parameterTypes) Returns the list of `Method` objects for the declared public methods of this class or interface that have the specified method name and parameter types.
public Class<?>	Returns: the declaring class for this class getDeclaringClass() If the class or interface represented by this `Class` object is a member of another class, returns the `Class` object representing the class in which it was declared.
private native Class<?>	getDeclaringClass0()
public Class<?>	Returns: the immediately enclosing class of the underlying class getEnclosingClass() Returns the immediately enclosing class of the underlying class.
public Constructor<?>	Returns: the immediately enclosing constructor of the underlying class, if that class is a local or anonymous class; otherwise `null`. getEnclosingConstructor() If this `Class` object represents a local or anonymous class within a constructor, returns a `Constructor` object representing the immediately enclosing constructor of the underlying class.
public Method	Returns: the immediately enclosing method of the underlying class, if that class is a local or anonymous class; otherwise `null`. getEnclosingMethod() If this `Class` object represents a local or anonymous class within a method, returns a `Method` object representing the immediately enclosing method of the underlying class.
private native Object[]	getEnclosingMethod0()
private Class.EnclosingMethodInfo	getEnclosingMethodInfo()
public T[]	Returns: an array containing the values comprising the enum class represented by this `Class` object in the order they're declared, or null if this `Class` object does not represent an enum class getEnumConstants() Returns the elements of this enum class or null if this Class object does not represent an enum class.
pack-priv T[]	getEnumConstantsShared() Returns the elements of this enum class or null if this Class object does not represent an enum class; identical to getEnumConstants except that the result is uncloned, cached, and shared by all callers.
pack-priv static byte[]	getExecutableTypeAnnotationBytes(Executable ex)
private GenericsFactory	getFactory()
public Field	Returns: the `Field` object of this class specified by `name` getField(String the field name name) Returns a `Field` object that reflects the specified public member field of the class or interface represented by this `Class` object.
private Field	getField0(String name)
public Field[]	Returns: the array of `Field` objects representing the public fields getFields() Returns an array containing `Field` objects reflecting all the accessible public fields of the class or interface represented by this `Class` object.
private ClassRepository	getGenericInfo()
public Type[]	Returns: an array of interfaces directly implemented by this class getGenericInterfaces() Returns the `Type`s representing the interfaces directly implemented by the class or interface represented by this `Class` object.
private native String	getGenericSignature0()
public Type	Returns: the direct superclass of the class represented by this `Class` object getGenericSuperclass() Returns the `Type` representing the direct superclass of the entity (class, interface, primitive type or void) represented by this `Class` object.
public Class<?>[]	Returns: an array of interfaces directly implemented by this class getInterfaces() Returns the interfaces directly implemented by the class or interface represented by this `Class` object.
private Class<?>[]	getInterfaces(boolean cloneArray)
private native Class<?>[]	getInterfaces0()
public Method	Returns: the `Method` object that matches the specified `name` and `parameterTypes` getMethod(String the name of the method name, Class<?>... the list of parameters parameterTypes) Returns a `Method` object that reflects the specified public member method of the class or interface represented by this `Class` object.
private Method	getMethod0(String name, Class<?>[] parameterTypes)
public Method[]	Returns: the array of `Method` objects representing the public methods of this class getMethods() Returns an array containing `Method` objects reflecting all the public methods of the class or interface represented by this `Class` object, including those declared by the class or interface and those inherited from superclasses and superinterfaces.
private PublicMethods.MethodList	getMethodsRecursive(String name, Class<?>[] parameterTypes, boolean includeStatic, boolean publicOnly)
public native int	Returns: the `int` representing the modifiers for this class getModifiers() Returns the Java language modifiers for this class or interface, encoded in an integer.
public Module	Returns: the module that this class or interface is a member of getModule() Returns the module that this class or interface is a member of.
public String	Returns: the name of the class, interface, or other entity represented by this `Class` object. getName() Returns the name of the entity (class, interface, array class, primitive type, or void) represented by this `Class` object.
public Class<?>	Returns: the nest host of this class or interface getNestHost() Returns the nest host of the nest to which the class or interface represented by this `Class` object belongs.
private native Class<?>	getNestHost0()
public Class<?>[]	Returns: an array of all classes and interfaces in the same nest as this class or interface getNestMembers() Returns an array containing `Class` objects representing all the classes and interfaces that are members of the nest to which the class or interface represented by this `Class` object belongs.
private native Class<?>[]	getNestMembers0()
public Package	Returns: the package of this class. getPackage() Gets the package of this class.
public String	Returns: the fully qualified package name getPackageName() Returns the fully qualified package name.
public Class<?>[]	Returns: an array of `Class` objects of the permitted subclasses of this class or interface, or `null` if this class or interface is not sealed. getPermittedSubclasses() Returns an array containing `Class` objects representing the direct subinterfaces or subclasses permitted to extend or implement this class or interface if it is sealed.
private native Class<?>[]	getPermittedSubclasses0()
pack-priv static native Class<?>	getPrimitiveClass(String name)
public ProtectionDomain	Returns: the ProtectionDomain of this class getProtectionDomain() Returns the `ProtectionDomain` of this class.
private native ProtectionDomain	getProtectionDomain0() Returns the ProtectionDomain of this class.
pack-priv native byte[]	getRawAnnotations()
pack-priv native byte[]	getRawTypeAnnotations()
public RecordComponent[]	Returns: An array of `RecordComponent` objects representing all the record components of this record class, or `null` if this class is not a record class getRecordComponents() Returns an array of `RecordComponent` objects representing all the record components of this record class, or `null` if this class is not a record class.
private native RecordComponent[]	getRecordComponents0()
private static ReflectionFactory	getReflectionFactory()
public URL	Returns: A `java.net.URL` object; `null` if no resource with this name is found, the resource cannot be located by a URL, the resource is in a package that is not open to at least the caller module, or access to the resource is denied by the security manager. getResource(String name of the desired resource name) Finds a resource with a given name.
public InputStream	Returns: A `java.io.InputStream` object; `null` if no resource with this name is found, the resource is in a package that is not open to at least the caller module, or access to the resource is denied by the security manager. getResourceAsStream(String name of the desired resource name) Finds a resource with a given name.
public native Object[]	Returns: the signers of this class, or null if there are no signers. In particular, this method returns null if this `Class` object represents a primitive type or void. getSigners() Gets the signers of this class.
private String	getSimpleBinaryName() Returns the "simple binary name" of the underlying class, i.e., the binary name without the leading enclosing class name.
private native String	getSimpleBinaryName0()
public String	Returns: the simple name of the underlying class getSimpleName() Returns the simple name of the underlying class as given in the source code.
private String	getSimpleName0()
public native Class<? super T>	Returns: the direct superclass of the class represented by this `Class` object getSuperclass() Returns the `Class` representing the direct superclass of the entity (class, interface, primitive type or void) represented by this `Class`.
public String	Returns: an informative string for the name of this class or interface getTypeName() Overrides default java.lang.reflect.Type.getTypeName. Return an informative string for the name of this class or interface.
public TypeVariable<Class<T>>[]	Returns: an array of `TypeVariable` objects that represent the type variables declared by this generic declaration getTypeParameters() Implements java.lang.reflect.GenericDeclaration.getTypeParameters. Returns an array of `TypeVariable` objects that represent the type variables declared by the generic declaration represented by this `GenericDeclaration` object, in declaration order.
private boolean	hasEnclosingMethodInfo()
private boolean	hasSealedAncestor(Class<?> clazz)
private native String	initClassName()
public boolean	Returns: `true` if this `Class` object represents an annotation interface; `false` otherwise isAnnotation() Returns true if this `Class` object represents an annotation interface.
public boolean	isAnnotationPresent(Class<? extends Annotation> the Class object corresponding to the annotation type annotationClass) Overrides default java.lang.reflect.AnnotatedElement.isAnnotationPresent. Returns true if an annotation for the specified type is present on this element, else false.
public boolean	Returns: `true` if and only if this class is an anonymous class. isAnonymousClass() Returns `true` if and only if the underlying class is an anonymous class.
public native boolean	Returns: `true` if this `Class` object represents an array class; `false` otherwise. isArray() Implements java.lang.invoke.TypeDescriptor.OfField.isArray. Determines if this `Class` object represents an array class.
public native boolean	Returns: the `boolean` value indicating whether objects of the type `cls` can be assigned to objects of this class isAssignableFrom(Class<?> the `Class` object to be checked cls) Determines if the class or interface represented by this `Class` object is either the same as, or is a superclass or superinterface of, the class or interface represented by the specified `Class` parameter.
private boolean	isDirectSubType(Class<?> c)
public boolean	Returns: true if and only if this class was declared as an enum in the source code isEnum() Returns true if and only if this class was declared as an enum in the source code.
public native boolean	Returns: `true` if and only if this class is a hidden class. isHidden() Returns `true` if and only if the underlying class is a hidden class.
public native boolean	Returns: true if `obj` is an instance of this class isInstance(Object the object to check obj) Determines if the specified `Object` is assignment-compatible with the object represented by this `Class`.
public native boolean	Returns: `true` if this `Class` object represents an interface; `false` otherwise. isInterface() Determines if this `Class` object represents an interface type.
public boolean	Returns: `true` if and only if this class is a local class. isLocalClass() Returns `true` if and only if the underlying class is a local class.
private boolean	isLocalOrAnonymousClass() Returns `true` if this is a local class or an anonymous class.
public boolean	Returns: `true` if and only if this class is a member class. isMemberClass() Returns `true` if and only if the underlying class is a member class.
public boolean	Returns: `true` if this class and `c` are members of the same nest; and `false` otherwise. isNestmateOf(Class<?> the class to check c) Determines if the given `Class` is a nestmate of the class or interface represented by this `Class` object.
private boolean	isOpenToCaller(String name, Class<?> caller) Returns true if a resource with the given name can be located by the given caller.
public native boolean	Returns: true if and only if this class represents a primitive type isPrimitive() Implements java.lang.invoke.TypeDescriptor.OfField.isPrimitive. Determines if this `Class` object represents a primitive type or void.
public boolean	Returns: true if and only if this class is a record class, otherwise false isRecord() Returns `true` if and only if this class is a record class.
private native boolean	isRecord0()
public boolean	Returns: `true` if and only if this `Class` object represents a sealed class or interface. isSealed() Returns `true` if and only if this `Class` object represents a sealed class or interface.
public boolean	Returns: `true` if and only if this class has the synthetic modifier bit set isSynthetic() Returns `true` if and only if this class has the synthetic modifier bit set.
private boolean	isTopLevelClass() Returns `true` if this is a top level class.
private String	methodToString(String name, Class<?>[] argTypes) Helper method to get the method name from arguments.
public T	Returns: a newly allocated instance of the class represented by this object. newInstance() Deprecated since 9. This method propagates any exception thrown by the nullary constructor, including a checked exception. Creates a new instance of the class represented by this `Class` object.
private Class.ReflectionData<T>	newReflectionData(SoftReference<Class.ReflectionData<T>> oldReflectionData, int classRedefinedCount)
private Constructor<T>[]	privateGetDeclaredConstructors(boolean publicOnly)
private Field[]	privateGetDeclaredFields(boolean publicOnly)
private Method[]	privateGetDeclaredMethods(boolean publicOnly)
private Field[]	privateGetPublicFields()
private Method[]	privateGetPublicMethods()
pack-priv ProtectionDomain	protectionDomain()
private Class.ReflectionData<T>	reflectionData()
private static native void	registerNatives()
private String	resolveName(String name) Add a package name prefix if the name is not absolute.
private static Field	searchFields(Field[] fields, String name)
private static Method	searchMethods(Method[] methods, String name, Class<?>[] parameterTypes)
pack-priv native void	setSigners(Object[] signers) Set the signers of this class.
private static Class<?>	toClass(Type o)
public String	Returns: a string describing this `Class`, including information about modifiers and type parameters toGenericString() Returns a string describing this `Class`, including information about modifiers, `sealed`/`non-sealed` status, and type parameters.
public String	Returns: a string representation of this `Class` object. toString() Overrides java.lang.Object.toString. Converts the object to a string.
pack-priv static String	typeVarBounds(TypeVariable<?> typeVar)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

public final Class Class<T>

Hidden Classes

Implicitly Declared Classes

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary