Note that since information about the runtime representation of a type is being generated, modifiers not present on the originating source code or illegal on the originating source code may be present.

Copy

                                                                                                            Class.forName(className, true, currentLoader)

                                                        
                                            

For example, the following code fragment returns the runtime Class descriptorobject for the class named java.lang.Thread:

Copy

                                                                                                            Class<?> t = Class.forName("java.lang.Thread");

                                                        
                                            

A call to forName("X") causes the class named X to be initialized.

In cases where this method is called from a context where there is no caller frame on the stack (e.g. when called directly from a JNI attached thread), the system class loader is used.

Copy

                                                                                                            Class.forName(className, true, currentLoader)

                                                        
                                            

For example, the following code fragment returns the runtime Class descriptor for the class named java.lang.Thread:

Copy

                                                                                                            Class<?> t = Class.forName("java.lang.Thread");

                                                        
                                            

A call to forName("X") causes the class named X to be initialized.

In cases where this method is called from a context where there is no caller frame on the stack (e.g. when called directly from a JNI attached thread), the system class loader is used.

Copy

                                                                                                            Class.forName(className, true, currentLoader)

                                                        
                                            

For example, the following code fragment returns the runtime Class object for the class named java.lang.Thread:

Copy

                                                                                                            Class<?> t = Class.forName("java.lang.Thread");

                                                        
                                            

A call to forName("X") causes the class named X to be initialized.

In cases where this method is called from a context where there is no caller frame on the stack (e.g. when called directly from a JNI attached thread), the system class loader is used.

This method cannot be used to obtain any of the Class objects representing primitive types or void, hidden classes or interfaces, or array classes whose element type is a hidden class or interface. If name denotes a primitive type or void, for example I, an attempt will be made to locate a user-defined class in the unnamed package whose name is name. Therefore, this method cannot be used toI instead.

To obtain any ofthe Class objects representing primitive types or void. If name denotesobject associated with an array class, the component typename consists of one or more '[' representing the depth of the array class is loaded but not initialized. For example,nesting, followed by the element type as encoded in an instance methodthe expressiontable specified in Class.getName().

Examples:

Copy

                                                                                                            Class<?> threadClass = Class.forName("Foojava.lang.Thread", false, currentLoader);
Class<?> stringArrayClass = Class.forName("[Ljava.lang.String;", false, currentLoader);
Class<?> intArrayClass = Class.forName("[[[I", false, currentLoader);   // Class of int[][][]
Class<?> nestedClass = Class.forName("java.lang.Character$UnicodeBlock", false, isequivalentto:CopycurrentLoader);
Class<?> fooClass = Class.forName("Foo", true, this.getClass(currentLoader).getClassLoader());

                                                        
                                            

A call to getName() on the Class object returned from forName(N) returns N.

A call to forName("[LN;") causes the element type named N to be loaded but not initialized regardless of the value of the initialize parameter.

If name denotes a primitive type or void, an attempt will be made to locate a user-defined class in the unnamed package whose name is name. Therefore, this method cannot be used to obtain any of the Class objects representing primitive types or void.

If name denotes an array class, the component type of the array class is loaded but not initialized.

For example, in an instance method the expression:

Copy

                                                                                                            Class.forName("Foo")

                                                        
                                            

Copy

                                                                                                            Class.forName("Foo", true, this.getClass().getClassLoader())

                                                        
                                            

This method cannot be used to obtain any of the Class objects representing primitive types or void, hidden classes or interfaces, or array classes whose element type is a hidden class or interface. If name denotes a primitive type or void, for example I, an attempt will be made to locate a user-defined class in the unnamed package whose name is I instead.

To obtain the Class object associated with an array class, the name consists of one or more '[' representing the depth of the array nesting, followed by the element type as encoded in the table specified in Class.getName().

Examples:

Copy

                                                                                                            Class<?> threadClass = Class.forName("java.lang.Thread", false, currentLoader);
Class<?> stringArrayClass = Class.forName("[Ljava.lang.String;", false, currentLoader);
Class<?> intArrayClass = Class.forName("[[[I", false, currentLoader);   // Class of int[][][]
Class<?> nestedClass = Class.forName("java.lang.Character$UnicodeBlock", false, currentLoader);
Class<?> fooClass = Class.forName("Foo", true, currentLoader);

                                                        
                                            

A call to getName() on the Class object returned from forName(N) returns N.

A call to forName("[LN;") causes the element type named N to be loaded but not initialized regardless of the value of the initialize parameter.

This method attempts to locate and load the class or interface. It does not link the class, and does not run the class initializer. If the class is not found, this method returns null.

If the class loader of the given module defines other modules and the given name is a class defined in a different module, this method returns null after the class is loaded.

This method does not check whether the requested class is accessible to its caller.

This method attempts to locate and load the class or interface. It does not link the class, and does not run the class initializer. If the class is not found, this method returns null.

If the class loader of the given module defines other modules and the given name is a class defined in a different module, this method returns null after the class is loaded.

This method does not check whether the requested class is accessible to its caller.

This method attempts to locate and load the class or interface. It does not link the class, and does not run the class initializer. If the class is not found, this method returns null.

If the class loader of the given module defines other modules and the given name is a class defined in a different module, this method returns null after the class is loaded.

This method does not check whether the requested class is accessible to its caller.

Specifically, if this Class object represents a declared class, this method returns true if the specified Object argument is an instance of the represented class (or of any of its subclasses); it returns false otherwise. If this Class object represents an array class, this method returns true if the specified Object argument can be converted to an object of the array class by an identity conversion or by a widening reference conversion; it returns false otherwise. If this Class object represents an interface, this method returns true if the class or any superclass of the specified Object argument implements this interface; it returns false otherwise. If this Class object represents a primitive type, this method returns false.

Specifically, this method tests whether the type represented by the specified Class parameter can be converted to the type represented by this Class object via an identity conversion or via a widening reference conversion. See The Java Language Specification , sections 5.1.1 and 5.1.4, for details.

There are nine predefined Class objects to represent the eight primitive types and void. These are created by the Java Virtual Machine, and have the same names as the primitive types that they represent, namely boolean, byte, char, short, int, long, float, and double.

These objects may only be accessed via the following public static final variables, and are the only Class objects for which this method returns true.

If this Class object represents a class or interface, not an array class, then:

• If the class or interface is not hidden, then the binary name of the class or interface is returned.
• If the class or interface is hidden, then the result is a string of the form: N + '/' + <suffix> where N is the binary name indicated by the class file passed to Lookup::defineHiddenClass, and <suffix> is an unqualified name.

If this Class object represents an array class, then the result is a string consisting of one or more '[' characters representing the depth of the array nesting, followed by the element type as encoded using the following table:

Element types and encodings

Element Type	Encoding
boolean	Z
byte	B
char	C
class or interface with binary name N	LN;
double	D
float	F
int	I
long	J
short	S

If this Class object represents a primitive type or void, then the result is a string with the same spelling as the Java language keyword which corresponds to the primitive type or void.

Examples:

                                                 String.class.getName()
     returns "java.lang.String"
 Character.UnicodeBlock.class.getName()
     returns "java.lang.Character$UnicodeBlock"
 byte.class.getName()
     returns "byte"
 (new Object[3]).getClass().getName()
     returns "[Ljava.lang.Object;"
 (new int[3][4][5][6][7][8][9]).getClass().getName()
     returns "[[[[[[[I"
 
                                            

If this Class object represents a class or interface, not an array class, then:

• If the class or interface is not hidden, then the binary name of the class or interface is returned.
• If the class or interface is hidden, then the result is a string of the form: N + '/' + <suffix> where N is the binary name indicated by the class file passed to Lookup::defineHiddenClass, and <suffix> is an unqualified name.

If this Class object represents an array class, then the result is a string consisting of one or more '[' characters representing the depth of the array nesting, followed by the element type as encoded using the following table:

Element types and encodings

Element Type	Encoding
boolean	Z
byte	B
char	C
class or interface with binary name N	LN;
double	D
float	F
int	I
long	J
short	S

If this Class object represents a primitive type or void, then the result is a string with the same spelling as the Java language keyword which corresponds to the primitive type or void.

Examples:

 String.class.getName()
     returns "java.lang.String"
 byte.class.getName()
     returns "byte"
 (new Object[3]).getClass().getName()
     returns "[Ljava.lang.Object;"
 (new int[3][4][5][6][7][8][9]).getClass().getName()
     returns "[[[[[[[I"
 

If this Class object represents a class or interface, not an array class, then:

• If the class or interface is not hidden, then the binary name of the class or interface is returned.
• If the class or interface is hidden, then the result is a string of the form: N + '/' + <suffix> where N is the binary name indicated by the class file passed to Lookup::defineHiddenClass, and <suffix> is an unqualified name.

If this Class object represents an array class, then the result is a string consisting of one or more '[' characters representing the depth of the array nesting, followed by the element type as encoded using the following table:

Element types and encodings

Element Type	Encoding
boolean	Z
byte	B
char	C
class or interface with binary name N	LN;
double	D
float	F
int	I
long	J
short	S

If this Class object represents a primitive type or void, then the result is a string with the same spelling as the Java language keyword which corresponds to the primitive type or void.

Examples:

 String.class.getName()
     returns "java.lang.String"
 Character.UnicodeBlock.class.getName()
     returns "java.lang.Character$UnicodeBlock"
 byte.class.getName()
     returns "byte"
 (new Object[3]).getClass().getName()
     returns "[Ljava.lang.Object;"
 (new int[3][4][5][6][7][8][9]).getClass().getName()
     returns "[[[[[[[I"
 

If this Class object represents a primitive type or void, null is returned.

If the superclass is a parameterized type, the Type object returned must accurately reflect the actual type arguments used in the source code. The parameterized type representing the superclass is created if it had not been created before. See the declaration of ParameterizedType for the semantics of the creation process for parameterized types. If this Class object represents either the Object class, an interface, a primitive type, or void, then null is returned. If this Class object represents an array class then the Class object representing the Object class is returned.

If this class represents an array type, a primitive type or void, this method returns null.

If this class is a top level class, then this method returns the fully qualified name of the package that the class is a member of, or the empty string if the class is in an unnamed package.

If this class is a member class, then this method is equivalent to invoking getPackageName() on the enclosing class .

If this class is a local class or an anonymous class , then this method is equivalent to invoking getPackageName() on the declaring class of the enclosing method or enclosing constructor .

If this class represents an array type then this method returns the package name of the element type. If this class represents a primitive type or void then the package name "java.lang" is returned.

If this Class object represents a class, the return value is an array containing objects representing all interfaces directly implemented by the class. The order of the interface objects in the array corresponds to the order of the interface names in the implements clause of the declaration of the class represented by this Class object. For example, given the declaration:

class Shimmer implements FloorWax, DessertTopping { ... }

s.getClass().getInterfaces()[0]

s.getClass().getInterfaces()[1]

If this Class object represents an interface, the array contains objects representing all interfaces directly extended by the interface. The order of the interface objects in the array corresponds to the order of the interface names in the extends clause of the declaration of the interface represented by this Class object.

If this Class object represents a class or interface that implements no interfaces, the method returns an array of length 0.

If this Class object represents a primitive type or void, the method returns an array of length 0.

If this Class object represents an array type, the interfaces Cloneable and java.io.Serializable are returned in that order.

If a superinterface is a parameterized type, the Type object returned for it must accurately reflect the actual type arguments used in the source code. The parameterized type representing each superinterface is created if it had not been created before. See the declaration of ParameterizedType for the semantics of the creation process for parameterized types.

If this Class object represents a class, the return value is an array containing objects representing all interfaces directly implemented by the class. The order of the interface objects in the array corresponds to the order of the interface names in the implements clause of the declaration of the class represented by this Class object.

If this Class object represents an interface, the array contains objects representing all interfaces directly extended by the interface. The order of the interface objects in the array corresponds to the order of the interface names in the extends clause of the declaration of the interface represented by this Class object.

If this Class object represents a class or interface that implements no interfaces, the method returns an array of length 0.

If this Class object represents a primitive type or void, the method returns an array of length 0.

If this Class object represents an array type, the interfaces Cloneable and java.io.Serializable are returned in that order.

If the underlying class is an array class:

• its public, private and protected modifiers are the same as those of its component type
• its abstract and final modifiers are always true
• its interface modifier is always false, even when the component type is an interface

The modifier encodings are defined in section 4.1 of The Java Virtual Machine Specification .

If the underlying class is an array class:

• its PUBLIC, PRIVATE and PROTECTED access flags are the same as those of its component type
• its ABSTRACT and FINAL flags are present
• its INTERFACE flag is absent, even when the component type is an interface

The simple name of an array class is the simple name of the component type with "[]" appended. In particular the simple name of an array class whose component type is anonymous is "[]".

• a local class
• a anonymous class
• an unnamed class ^PREVIEW
• a hidden class
• an array whose component type does not have a canonical name

An array type has a canonical name if and only if its component type has a canonical name. When an array type has a canonical name, it is equal to the canonical name of the component type followed by "[]".

If this Class object represents a class or interface with no accessible public fields, then this method returns an array of length 0.

If this Class object represents a class, then this method returns the public fields of the class and of all its superclasses and superinterfaces.

If this Class object represents an interface, then this method returns the fields of the interface and of all its superinterfaces.

If this Class object represents an array type, a primitive type, or void, then this method returns an array of length 0.

The elements in the returned array are not sorted and are not in any particular order.

If this Class object represents an array type, then the returned array has a Method object for each of the public methods inherited by the array type from Object. It does not contain a Method object for clone().

If this Class object represents an interface then the returned array does not contain any implicitly declared methods from Object. Therefore, if no methods are explicitly declared in this interface or any of its superinterfaces then the returned array has length 0. (Note that a Class object which represents a class always has public methods, inherited from Object.)

The returned array never contains methods with names "<init>" or "<clinit>".

The elements in the returned array are not sorted and are not in any particular order.

Generally, the result is computed as with the following 4 step algorithm. Let C be the class or interface represented by this Class object:

1. A union of methods is composed of:
   1. C's declared public instance and static methods as returned by getDeclaredMethods() and filtered to include only public methods.
   2. If C is a class other than Object, then include the result of invoking this algorithm recursively on the superclass of C.
   3. Include the results of invoking this algorithm recursively on all direct superinterfaces of C, but include only instance methods.
2. Union from step 1 is partitioned into subsets of methods with same signature (name, parameter types) and return type.
3. Within each such subset only the most specific methods are selected. Let method M be a method from a set of methods with same signature and return type. M is most specific if there is no such method N != M from the same set, such that N is more specific than M. N is more specific than M if:
   1. N is declared by a class and M is declared by an interface; or
   2. N and M are both declared by classes or both by interfaces and N's declaring type is the same as or a subtype of M's declaring type (clearly, if M's and N's declaring types are the same type, then M and N are the same method).
4. The result of this algorithm is the union of all selected methods from step 3.

The field to be reflected is determined by the algorithm that follows. Let C be the class or interface represented by this Class object:

1. If C declares a public field with the name specified, that is the field to be reflected.
2. If no field was found in step 1 above, this algorithm is applied recursively to each direct superinterface of C. The direct superinterfaces are searched in the order they were declared.
3. If no field was found in steps 1 and 2 above, and C has a superclass S, then this algorithm is invoked recursively upon S. If C has no superclass, then a NoSuchFieldException is thrown.

If this Class object represents an array type, then this method does not find the length field of the array type.

If this Class object represents an array type, then this method finds any public method inherited by the array type from Object except method clone().

If this Class object represents an interface then this method does not find any implicitly declared method from Object. Therefore, if no methods are explicitly declared in this interface or any of its superinterfaces, then this method does not find any method.

This method does not find any method with name "<init>" or "<clinit>".

Generally, the method to be reflected is determined by the 4 step algorithm that follows. Let C be the class or interface represented by this Class object:

1. A union of methods is composed of:
   1. C's declared public instance and static methods as returned by getDeclaredMethods() and filtered to include only public methods that match given name and parameterTypes
   2. If C is a class other than Object, then include the result of invoking this algorithm recursively on the superclass of C.
   3. Include the results of invoking this algorithm recursively on all direct superinterfaces of C, but include only instance methods.
2. This union is partitioned into subsets of methods with same return type (the selection of methods from step 1 also guarantees that they have the same method name and parameter types).
3. Within each such subset only the most specific methods are selected. Let method M be a method from a set of methods with same VM signature (return type, name, parameter types). M is most specific if there is no such method N != M from the same set, such that N is more specific than M. N is more specific than M if:
   1. N is declared by a class and M is declared by an interface; or
   2. N and M are both declared by classes or both by interfaces and N's declaring type is the same as or a subtype of M's declaring type (clearly, if M's and N's declaring types are the same type, then M and N are the same method).
4. The result of this algorithm is chosen arbitrarily from the methods with most specific return type among all selected methods from step 3. Let R be a return type of a method M from the set of all selected methods from step 3. M is a method with most specific return type if there is no such method N != M from the same set, having return type S != R, such that S is a subtype of R as determined by R.class.isAssignableFrom(java.lang.Class<?>)(S.class).

The constructor to reflect is the public constructor of the class represented by this Class object whose formal parameter types match those specified by parameterTypes.

If this Class object represents a class or interface with no declared fields, then this method returns an array of length 0.

If this Class object represents an array type, a primitive type, or void, then this method returns an array of length 0.

The elements in the returned array are not sorted and are not in any particular order.

The components are returned in the same order that they are declared in the record header. The array is empty if this record class has no components. If the class is not a record class, that is isRecord() returns false, then this method returns null. Conversely, if isRecord() returns true, then this method returns a non-null value.

If this Class object represents a class or interface that has multiple declared methods with the same name and parameter types, but different return types, then the returned array has a Method object for each such method.

If this Class object represents a class or interface that has a class initialization method "<clinit>", then the returned array does not have a corresponding Method object.

If this Class object represents a class or interface with no declared methods, then the returned array has length 0.

If this Class object represents an array type, a primitive type, or void, then the returned array has length 0.

The elements in the returned array are not sorted and are not in any particular order.

If this Class object represents an array type, then this method does not find the length field of the array type.

If this Class object represents an array type, then this method does not find the clone() method.

If this class is in a named Module then this method will attempt to find the resource in the module. This is done by delegating to the module's class loader findResource(String,String) method, invoking it with the module name and the absolute name of the resource. Resources in named modules are subject to the rules for encapsulation specified in the ModulegetResourceAsStream method and so this method returns null when the resource is a non-".class" resource in a package that is not open to the caller's module.

Otherwise, if this class is not in a named module then the rules for searching resources associated with a given class are implemented by the defining class loader of the class. This method delegates to this Class object's class loader. If this Class object was loaded by the bootstrap class loader, the method delegates to ClassLoader.getSystemResourceAsStream(java.lang.String).

Before delegation, an absolute resource name is constructed from the given resource name using this algorithm:

• If the name begins with a '/' ('\u002f'), then the absolute name of the resource is the portion of the name following the '/'.
• Otherwise, the absolute name is of the following form:

  modified_package_name/name

  Where the modified_package_name is the package name of this object with '/' substituted for '.' ('\u002e').

If this class is in a named Module then this method will attempt to find the resource in the module. This is done by delegating to the module's class loader findResource(String,String) method, invoking it with the module name and the absolute name of the resource. Resources in named modules are subject to the rules for encapsulation specified in the ModulegetResourceAsStream method and so this method returns null when the resource is a non-".class" resource in a package that is not open to the caller's module.

Otherwise, if this class is not in a named module then the rules for searching resources associated with a given class are implemented by the defining class loader of the class. This method delegates to this Class object's class loader. If this Class object was loaded by the bootstrap class loader, the method delegates to ClassLoader.getSystemResource(java.lang.String).

Before delegation, an absolute resource name is constructed from the given resource name using this algorithm:

• If the name begins with a '/' ('\u002f'), then the absolute name of the resource is the portion of the name following the '/'.
• Otherwise, the absolute name is of the following form:

  modified_package_name/name

  Where the modified_package_name is the package name of this object with '/' substituted for '.' ('\u002e').

The direct superclass of a record class is java.lang.Record. A record class is final. A record class has (possibly zero) record components; getRecordComponents() returns a non-null but possibly empty value for a record.

Note that class Record is not a record class and thus invoking this method on class Record returns false.

This method is useful when a client needs to "narrow" the type of a Class object to pass it to an API that restricts the Class objects that it is willing to accept. A cast would generate a compile-time warning, as the correctness of the cast could not be checked at runtime (because generic types are implemented by erasure).

Note that any annotation returned by this method is a declaration annotation.

The truth value returned by this method is equivalent to: getAnnotation(annotationClass) != null

Note that any annotations returned by this method are declaration annotations.

Note that any annotations returned by this method are declaration annotations.

Note that any annotation returned by this method is a declaration annotation.

Note that any annotations returned by this method are declaration annotations.

Note that any annotations returned by this method are declaration annotations.

If this Class object represents a class whose declaration does not explicitly indicate an annotated superclass, then the return value is an AnnotatedType object representing an element with no annotations.

If this Class represents either the Object class, an interface type, an array type, a primitive type, or void, the return value is null.

If this Class object represents a class, the return value is an array containing objects representing the uses of interface types to specify interfaces implemented by the class. The order of the objects in the array corresponds to the order of the interface types used in the 'implements' clause of the declaration of this Class object.

If this Class object represents an interface, the return value is an array containing objects representing the uses of interface types to specify interfaces directly extended by the interface. The order of the objects in the array corresponds to the order of the interface types used in the 'extends' clause of the declaration of this Class object.

If this Class object represents a class or interface whose declaration does not explicitly indicate any annotated superinterfaces, the return value is an array of length 0.

If this Class object represents either the Object class, an array type, a primitive type, or void, the return value is an array of length 0.

If this Class object represents a primitive type, an array type, or void, then this method returns this, indicating that the represented entity belongs to the nest consisting only of itself, and is the nest host.

If this Class object represents a primitive type, an array type, or void, then this method returns a single-element array containing this.

If this Class object represents a class or interface, not an array class, then:

• If the class or interface is not hidden, then the result is a field descriptor (JVMS 4.3.2) for the class or interface. Calling ClassDesc::ofDescriptor with the result descriptor string produces a ClassDesc describing this class or interface.
• If the class or interface is hidden, then the result is a string of the form:

  "L" + N+ "." + <suffix> + ";"

  where N is the binary name encoded in internal form indicated by the class file passed to Lookup::defineHiddenClass, and <suffix> is an unqualified name. A hidden class or interface has no nominal descriptor . The result string is not a type descriptor.

If this Class object represents an array class, then the result is a string consisting of one or more '[' characters representing the depth of the array nesting, followed by the descriptor string of the element type.

• If the element type is not a hidden class or interface, then this array class can be described nominally. Calling ClassDesc::ofDescriptor with the result descriptor string produces a ClassDesc describing this array class.
• If the element type is a hidden class or interface, then this array class cannot be described nominally. The result string is not a type descriptor.

If this Class object represents a primitive type or void, then the result is a field descriptor string which is a one-letter code corresponding to a primitive type or void ("B", "C", "D", "F", "I", "J", "S", "Z", "V" ) (JVMS 4.3.2).