* #### toString
public [String](../../java/lang/String.html "class in java.lang") toString()
Converts the object to a string. The string representation is the string "class" or "interface", followed by a space, and then by the fully qualified name of the class in the format returned by`getName`. If this `Class` object represents a primitive type, this method returns the name of the primitive type. If this `Class` object represents void this method returns "void". If this `Class` object represents an array type, this method returns "class " followed by `getName`.
Overrides:
`[toString](../../java/lang/Object.html#toString--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`
Returns:
a string representation of this class object.
* #### toGenericString
public [String](../../java/lang/String.html "class in java.lang") toGenericString()
Returns a string describing this `Class`, including information about modifiers and type parameters. The string is formatted as a list of type modifiers, if any, followed by the kind of type (empty string for primitive types and `class`, `enum`, `interface`, or`@` `interface`, as appropriate), followed by the type's name, followed by an angle-bracketed comma-separated list of the type's type parameters, if any. A space is used to separate modifiers from one another and to separate any modifiers from the kind of type. The modifiers occur in canonical order. If there are no type parameters, the type parameter list is elided. For an array type, the string starts with the type name, followed by an angle-bracketed comma-separated list of the type's type parameters, if any, followed by a sequence of`[]` characters, one set of brackets per dimension of the array.
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.
Returns:
a string describing this `Class`, including information about modifiers and type parameters
Since:
1.8
* #### forName
public static [Class](../../java/lang/Class.html "class in java.lang")<?> forName([String](../../java/lang/String.html "class in java.lang") className)
throws [ClassNotFoundException](../../java/lang/ClassNotFoundException.html "class in java.lang")
Returns the `Class` object associated with the class or interface with the given string name. Invoking this method is equivalent to:
> `Class.forName(className, true, currentLoader)`
where `currentLoader` denotes the defining class loader of the current class.
For example, the following code fragment returns the runtime `Class` descriptor for the class named`java.lang.Thread`:
> `Class t = Class.forName("java.lang.Thread")`
A call to `forName("X")` causes the class named`X` to be initialized.
Parameters:
`className` \- the fully qualified name of the desired class.
Returns:
the `Class` object for the class with the specified name.
Throws:
`[LinkageError](../../java/lang/LinkageError.html "class in java.lang")` \- if the linkage fails
`[ExceptionInInitializerError](../../java/lang/ExceptionInInitializerError.html "class in java.lang")` \- if the initialization provoked by this method fails
`[ClassNotFoundException](../../java/lang/ClassNotFoundException.html "class in java.lang")` \- if the class cannot be located
* #### forName
public static [Class](../../java/lang/Class.html "class in java.lang")<?> forName([String](../../java/lang/String.html "class in java.lang") name,
boolean initialize,
[ClassLoader](../../java/lang/ClassLoader.html "class in java.lang") loader)
throws [ClassNotFoundException](../../java/lang/ClassNotFoundException.html "class in java.lang")
Returns the `Class` object associated with the class or interface with the given string name, using the given class loader. Given the fully qualified name for a class or interface (in the same format returned by `getName`) this method attempts to locate, load, and link the class or interface. The specified class loader is used to load the class or interface. If the parameter`loader` is null, the class is loaded through the bootstrap class loader. The class is initialized only if the`initialize` parameter is `true` and if it has not been initialized earlier.
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:
> `Class.forName("Foo")`
is equivalent to:
> `Class.forName("Foo", true, this.getClass().getClassLoader())`
Note that this method throws errors related to loading, linking or initializing as specified in Sections 12.2, 12.3 and 12.4 of _The Java Language Specification_. Note that this method does not check whether the requested class is accessible to its caller.
Parameters:
`name` \- fully qualified name of the desired class
`initialize` \- if `true` the class will be initialized. See Section 12.4 of _The Java Language Specification_.
`loader` \- class loader from which the class must be loaded
Returns:
class object representing the desired class
Throws:
`[LinkageError](../../java/lang/LinkageError.html "class in java.lang")` \- if the linkage fails
`[ExceptionInInitializerError](../../java/lang/ExceptionInInitializerError.html "class in java.lang")` \- if the initialization provoked by this method fails
`[ClassNotFoundException](../../java/lang/ClassNotFoundException.html "class in java.lang")` \- if the class cannot be located by the specified class loader
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager is present, and the `loader` is`null`, and the caller's class loader is not`null`, and the caller does not have the[RuntimePermission](../../java/lang/RuntimePermission.html "class in java.lang")`("getClassLoader")`
Since:
1.2
See Also:
[forName(String)](../../java/lang/Class.html#forName-java.lang.String-), [ClassLoader](../../java/lang/ClassLoader.html "class in java.lang")
* #### forName
public static [Class](../../java/lang/Class.html "class in java.lang")<?> forName([Module](../../java/lang/Module.html "class in java.lang") module,
[String](../../java/lang/String.html "class in java.lang") name)
Returns the `Class` with the given [ binary name](ClassLoader.html#name) in the given module.
This method attempts to locate, load, and link the class or interface. It 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.
API Note:
This method returns `null` on failure rather than throwing a [ClassNotFoundException](../../java/lang/ClassNotFoundException.html "class in java.lang"), as is done by the [forName(String, boolean, ClassLoader)](../../java/lang/Class.html#forName-java.lang.String-boolean-java.lang.ClassLoader-) method. The security check is a stack-based permission check if the caller loads a class in another module.
Parameters:
`module` \- A module
`name` \- The [binary name](ClassLoader.html#name) of the class
Returns:
`Class` object of the given name defined in the given module;`null` if not found.
Throws:
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the given module or name is `null`
`[LinkageError](../../java/lang/LinkageError.html "class in java.lang")` \- if the linkage fails
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \-
* if the caller is not the specified module and`RuntimePermission("getClassLoader")` permission is denied; or
* access to the module content is denied. For example, permission check will be performed when a class loader calls[ModuleReader.open(String)](../../java/lang/module/ModuleReader.html#open-java.lang.String-) to read the bytes of a class file in a module.
Since:
9
* #### newInstance
[@Deprecated](../../java/lang/Deprecated.html "annotation in java.lang")([since](../../java/lang/Deprecated.html#since--)="9")
public [T](../../java/lang/Class.html "type parameter in Class") newInstance()
throws [InstantiationException](../../java/lang/InstantiationException.html "class in java.lang"),
[IllegalAccessException](../../java/lang/IllegalAccessException.html "class in java.lang")
Deprecated.
Creates a new instance of the class represented by this `Class` object. The class is instantiated as if by a `new` expression with an empty argument list. The class is initialized if it has not already been initialized.
Returns:
a newly allocated instance of the class represented by this object.
Throws:
`[IllegalAccessException](../../java/lang/IllegalAccessException.html "class in java.lang")` \- if the class or its nullary constructor is not accessible.
`[InstantiationException](../../java/lang/InstantiationException.html "class in java.lang")` \- if this `Class` represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no nullary constructor; or if the instantiation fails for some other reason.
`[ExceptionInInitializerError](../../java/lang/ExceptionInInitializerError.html "class in java.lang")` \- if the initialization provoked by this method fails.
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class.
* #### isInstance
public boolean isInstance([Object](../../java/lang/Object.html "class in java.lang") obj)
Determines if the specified `Object` is assignment-compatible with the object represented by this `Class`. This method is the dynamic equivalent of the Java language `instanceof` operator. The method returns `true` if the specified`Object` argument is non-null and can be cast to the reference type represented by this `Class` object without raising a `ClassCastException.` It returns `false` otherwise.
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`.
Parameters:
`obj` \- the object to check
Returns:
true if `obj` is an instance of this class
Since:
1.1
* #### isAssignableFrom
public boolean isAssignableFrom([Class](../../java/lang/Class.html "class in java.lang")<?> 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. It returns `true` if so; otherwise it returns `false`. If this `Class` object represents a primitive type, this method returns`true` if the specified `Class` parameter is exactly this `Class` object; otherwise it 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.
Parameters:
`cls` \- the `Class` object to be checked
Returns:
the `boolean` value indicating whether objects of the type `cls` can be assigned to objects of this class
Throws:
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified Class parameter is null.
Since:
1.1
* #### isInterface
public boolean isInterface()
Determines if the specified `Class` object represents an interface type.
Returns:
`true` if this object represents an interface;`false` otherwise.
* #### isArray
public boolean isArray()
Determines if this `Class` object represents an array class.
Returns:
`true` if this object represents an array class;`false` otherwise.
Since:
1.1
* #### isPrimitive
public boolean isPrimitive()
Determines if the specified `Class` object represents a primitive type.
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`.
Returns:
true if and only if this class represents a primitive type
Since:
1.1
See Also:
[Boolean.TYPE](../../java/lang/Boolean.html#TYPE), [Character.TYPE](../../java/lang/Character.html#TYPE), [Byte.TYPE](../../java/lang/Byte.html#TYPE), [Short.TYPE](../../java/lang/Short.html#TYPE), [Integer.TYPE](../../java/lang/Integer.html#TYPE), [Long.TYPE](../../java/lang/Long.html#TYPE), [Float.TYPE](../../java/lang/Float.html#TYPE), [Double.TYPE](../../java/lang/Double.html#TYPE), [Void.TYPE](../../java/lang/Void.html#TYPE)
* #### isAnnotation
public boolean isAnnotation()
Returns true if this `Class` object represents an annotation type. Note that if this method returns true, [isInterface()](../../java/lang/Class.html#isInterface--) would also return true, as all annotation types are also interfaces.
Returns:
`true` if this class object represents an annotation type; `false` otherwise
Since:
1.5
* #### isSynthetic
public boolean isSynthetic()
Returns `true` if this class is a synthetic class; returns `false` otherwise.
Returns:
`true` if and only if this class is a synthetic class as defined by the Java Language Specification.
Since:
1.5
See The Java™ Language Specification:
13.1 The Form of a Binary
* #### getName
public [String](../../java/lang/String.html "class in java.lang") getName()
Returns the name of the entity (class, interface, array class, primitive type, or void) represented by this `Class` object, as a `String`.
If this class object represents a reference type that is not an array type then the binary name of the class is returned, as specified byThe Java™ Language Specification.
If this class object represents a primitive type or void, then the name returned is a `String` equal to the Java language keyword corresponding to the primitive type or void.
If this class object represents a class of arrays, then the internal form of the name consists of the name of the element type preceded by one or more '`[`' characters representing the depth of the array nesting. The encoding of element type names is as follows:
> __Element types and encodings__
> | Element Type | Encoding |
> | ------------------ | ------------- |
> | boolean | Z |
> | byte | B |
> | char | C |
> | class or interface | L_classname_; |
> | double | D |
> | float | F |
> | int | I |
> | long | J |
> | short | S |
The class or interface name _classname_ is the binary name of the class specified above.
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"
>
Returns:
the name of the class or interface represented by this object.
* #### getClassLoader
public [ClassLoader](../../java/lang/ClassLoader.html "class in java.lang") getClassLoader()
Returns the class loader for the class. Some implementations may use null to represent the bootstrap class loader. This method will return null in such implementations if this class was loaded by the bootstrap class loader.
If this object represents a primitive type or void, null is returned.
Returns:
the class loader that loaded the class or interface represented by this object.
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager is present, and the caller's class loader is not `null` and is not the same as or an ancestor of the class loader for the class whose class loader is requested, and the caller does not have the[RuntimePermission](../../java/lang/RuntimePermission.html "class in java.lang")`("getClassLoader")`
See Also:
[ClassLoader](../../java/lang/ClassLoader.html "class in java.lang"), [SecurityManager.checkPermission(java.security.Permission)](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-), [RuntimePermission](../../java/lang/RuntimePermission.html "class in java.lang")
* #### getModule
public [Module](../../java/lang/Module.html "class in java.lang") getModule()
Returns the module that this class or interface is a member of. If this class represents an array type then this method returns the`Module` for the element type. If this class represents a primitive type or void, then the `Module` object for the`java.base` module is returned. If this class is in an unnamed module then the [unnamed](../../java/lang/ClassLoader.html#getUnnamedModule--) `Module` of the class loader for this class is returned.
Returns:
the module that this class or interface is a member of
Since:
9
* #### getTypeParameters
public [TypeVariable](../../java/lang/reflect/TypeVariable.html "interface in java.lang.reflect")<[Class](../../java/lang/Class.html "class in java.lang")<[T](../../java/lang/Class.html "type parameter in Class")>>[] 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. Returns an array of length 0 if the underlying generic declaration declares no type variables.
Specified by:
`[getTypeParameters](../../java/lang/reflect/GenericDeclaration.html#getTypeParameters--)` in interface `[GenericDeclaration](../../java/lang/reflect/GenericDeclaration.html "interface in java.lang.reflect")`
Returns:
an array of `TypeVariable` objects that represent the type variables declared by this generic declaration
Throws:
`[GenericSignatureFormatError](../../java/lang/reflect/GenericSignatureFormatError.html "class in java.lang.reflect")` \- if the generic signature of this generic declaration does not conform to the format specified inThe Java™ Virtual Machine Specification
Since:
1.5
* #### getSuperclass
public [Class](../../java/lang/Class.html "class in java.lang")<? super [T](../../java/lang/Class.html "type parameter in Class")> getSuperclass()
Returns the `Class` representing the direct superclass of the entity (class, interface, primitive type or void) represented by this `Class`. If this `Class` represents either the`Object` class, an interface, a primitive type, or void, then null is returned. If this object represents an array class then the`Class` object representing the `Object` class is returned.
Returns:
the direct superclass of the class represented by this object
* #### getGenericSuperclass
public [Type](../../java/lang/reflect/Type.html "interface in java.lang.reflect") getGenericSuperclass()
Returns the `Type` representing the direct superclass of the entity (class, interface, primitive type or void) represented by this `Class`.
If the superclass is a parameterized type, the `Type` object returned must accurately reflect the actual type parameters 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](../../java/lang/reflect/ParameterizedType.html "interface in java.lang.reflect") for the semantics of the creation process for parameterized types. If this `Class` represents either the `Object` class, an interface, a primitive type, or void, then null is returned. If this object represents an array class then the`Class` object representing the `Object` class is returned.
Returns:
the direct superclass of the class represented by this object
Throws:
`[GenericSignatureFormatError](../../java/lang/reflect/GenericSignatureFormatError.html "class in java.lang.reflect")` \- if the generic class signature does not conform to the format specified inThe Java™ Virtual Machine Specification
`[TypeNotPresentException](../../java/lang/TypeNotPresentException.html "class in java.lang")` \- if the generic superclass refers to a non-existent type declaration
`[MalformedParameterizedTypeException](../../java/lang/reflect/MalformedParameterizedTypeException.html "class in java.lang.reflect")` \- if the generic superclass refers to a parameterized type that cannot be instantiated for any reason
Since:
1.5
* #### getPackage
public [Package](../../java/lang/Package.html "class in java.lang") getPackage()
Gets the package of this class.
If this class represents an array type, a primitive type or void, this method returns `null`.
Returns:
the package of this class.
* #### getPackageName
public [String](../../java/lang/String.html "class in java.lang") getPackageName()
Returns the fully qualified package name.
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](../../java/lang/Class.html#getEnclosingClass--).
If this class is a [local class](../../java/lang/Class.html#isLocalClass--) or an [anonymous class](../../java/lang/Class.html#isAnonymousClass--), then this method is equivalent to invoking `getPackageName()` on the [declaring class](../../java/lang/Class.html#getDeclaringClass--) of the [enclosing method](../../java/lang/Class.html#getEnclosingMethod--) or[enclosing constructor](../../java/lang/Class.html#getEnclosingConstructor--).
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.
Returns:
the fully qualified package name
Since:
9
See The Java™ Language Specification:
6.7 Fully Qualified Names
* #### getInterfaces
public [Class](../../java/lang/Class.html "class in java.lang")<?>[] getInterfaces()
Returns the interfaces directly implemented by the class or interface represented by this object.
If this 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 object. For example, given the declaration:
> `class Shimmer implements FloorWax, DessertTopping { ... }`
suppose the value of `s` is an instance of`Shimmer`; the value of the expression:
> `s.getClass().getInterfaces()[0]`
is the `Class` object that represents interface`FloorWax`; and the value of:
> `s.getClass().getInterfaces()[1]`
is the `Class` object that represents interface`DessertTopping`.
If this 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 object.
If this object represents a class or interface that implements no interfaces, the method returns an array of length 0.
If this 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.
Returns:
an array of interfaces directly implemented by this class
* #### getGenericInterfaces
public [Type](../../java/lang/reflect/Type.html "interface in java.lang.reflect")[] getGenericInterfaces()
Returns the `Type`s representing the interfaces directly implemented by the class or interface represented by this object.
If a superinterface is a parameterized type, the`Type` object returned for it must accurately reflect the actual type parameters 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](../../java/lang/reflect/ParameterizedType.html "interface in java.lang.reflect") for the semantics of the creation process for parameterized types.
If this 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 object.
If this 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 object.
If this object represents a class or interface that implements no interfaces, the method returns an array of length 0.
If this 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.
Returns:
an array of interfaces directly implemented by this class
Throws:
`[GenericSignatureFormatError](../../java/lang/reflect/GenericSignatureFormatError.html "class in java.lang.reflect")` \- if the generic class signature does not conform to the format specified inThe Java™ Virtual Machine Specification
`[TypeNotPresentException](../../java/lang/TypeNotPresentException.html "class in java.lang")` \- if any of the generic superinterfaces refers to a non-existent type declaration
`[MalformedParameterizedTypeException](../../java/lang/reflect/MalformedParameterizedTypeException.html "class in java.lang.reflect")` \- if any of the generic superinterfaces refer to a parameterized type that cannot be instantiated for any reason
Since:
1.5
* #### getComponentType
public [Class](../../java/lang/Class.html "class in java.lang")<?> getComponentType()
Returns the `Class` representing the component type of an array. If this class does not represent an array class this method returns null.
Returns:
the `Class` representing the component type of this class if this class is an array
Since:
1.1
See Also:
[Array](../../java/lang/reflect/Array.html "class in java.lang.reflect")
* #### getModifiers
public int getModifiers()
Returns the Java language modifiers for this class or interface, encoded in an integer. The modifiers consist of the Java Virtual Machine's constants for `public`, `protected`,`private`, `final`, `static`,`abstract` and `interface`; they should be decoded using the methods of class `Modifier`.
If the underlying class is an array class, then its`public`, `private` and `protected` modifiers are the same as those of its component type. If this`Class` represents a primitive type or void, its`public` modifier is always `true`, and its`protected` and `private` modifiers are always`false`. If this object represents an array class, a primitive type or void, then its `final` modifier is always`true` and its interface modifier is always`false`. The values of its other modifiers are not determined by this specification.
The modifier encodings are defined in _The Java Virtual Machine Specification_, table 4.1.
Returns:
the `int` representing the modifiers for this class
Since:
1.1
See Also:
[Modifier](../../java/lang/reflect/Modifier.html "class in java.lang.reflect")
* #### getSigners
public [Object](../../java/lang/Object.html "class in java.lang")[] getSigners()
Gets the signers of this class.
Returns:
the signers of this class, or null if there are no signers. In particular, this method returns null if this object represents a primitive type or void.
Since:
1.1
* #### getEnclosingMethod
public [Method](../../java/lang/reflect/Method.html "class in java.lang.reflect") getEnclosingMethod()
throws [SecurityException](../../java/lang/SecurityException.html "class in java.lang")
If this `Class` object represents a local or anonymous class within a method, returns a [Method](../../java/lang/reflect/Method.html "class in java.lang.reflect") object representing the immediately enclosing method of the underlying class. Returns`null` otherwise. In particular, this method returns `null` if the underlying class is a local or anonymous class immediately enclosed by a type declaration, instance initializer or static initializer.
Returns:
the immediately enclosing method of the underlying class, if that class is a local or anonymous class; otherwise `null`.
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and any of the following conditions is met:
* the caller's class loader is not the same as the class loader of the enclosing class and invocation of[s.checkPermission](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-) method with`RuntimePermission("accessDeclaredMembers")` denies access to the methods within the enclosing class
* the caller's class loader is not the same as or an ancestor of the class loader for the enclosing class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of the enclosing class
Since:
1.5
* #### getEnclosingConstructor
public [Constructor](../../java/lang/reflect/Constructor.html "class in java.lang.reflect")<?> getEnclosingConstructor()
throws [SecurityException](../../java/lang/SecurityException.html "class in java.lang")
If this `Class` object represents a local or anonymous class within a constructor, returns a [Constructor](../../java/lang/reflect/Constructor.html "class in java.lang.reflect") object representing the immediately enclosing constructor of the underlying class. Returns `null` otherwise. In particular, this method returns `null` if the underlying class is a local or anonymous class immediately enclosed by a type declaration, instance initializer or static initializer.
Returns:
the immediately enclosing constructor of the underlying class, if that class is a local or anonymous class; otherwise `null`.
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and any of the following conditions is met:
* the caller's class loader is not the same as the class loader of the enclosing class and invocation of[s.checkPermission](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-) method with`RuntimePermission("accessDeclaredMembers")` denies access to the constructors within the enclosing class
* the caller's class loader is not the same as or an ancestor of the class loader for the enclosing class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of the enclosing class
Since:
1.5
* #### getDeclaringClass
public [Class](../../java/lang/Class.html "class in java.lang")<?> getDeclaringClass()
throws [SecurityException](../../java/lang/SecurityException.html "class in java.lang")
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. This method returns null if this class or interface is not a member of any other class. If this `Class` object represents an array class, a primitive type, or void,then this method returns null.
Returns:
the declaring class for this class
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and the caller's class loader is not the same as or an ancestor of the class loader for the declaring class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of the declaring class
Since:
1.1
* #### getEnclosingClass
public [Class](../../java/lang/Class.html "class in java.lang")<?> getEnclosingClass()
throws [SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns the immediately enclosing class of the underlying class. If the underlying class is a top level class this method returns `null`.
Returns:
the immediately enclosing class of the underlying class
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and the caller's class loader is not the same as or an ancestor of the class loader for the enclosing class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of the enclosing class
Since:
1.5
* #### getSimpleName
public [String](../../java/lang/String.html "class in java.lang") getSimpleName()
Returns the simple name of the underlying class as given in the source code. Returns an empty string if the underlying class is anonymous.
The simple name of an array is the simple name of the component type with "\[\]" appended. In particular the simple name of an array whose component type is anonymous is "\[\]".
Returns:
the simple name of the underlying class
Since:
1.5
* #### getTypeName
public [String](../../java/lang/String.html "class in java.lang") getTypeName()
Return an informative string for the name of this type.
Specified by:
`[getTypeName](../../java/lang/reflect/Type.html#getTypeName--)` in interface `[Type](../../java/lang/reflect/Type.html "interface in java.lang.reflect")`
Returns:
an informative string for the name of this type
Since:
1.8
* #### getCanonicalName
public [String](../../java/lang/String.html "class in java.lang") getCanonicalName()
Returns the canonical name of the underlying class as defined by the Java Language Specification. Returns null if the underlying class does not have a canonical name (i.e., if it is a local or anonymous class or an array whose component type does not have a canonical name).
Returns:
the canonical name of the underlying class if it exists, and`null` otherwise.
Since:
1.5
* #### isAnonymousClass
public boolean isAnonymousClass()
Returns `true` if and only if the underlying class is an anonymous class.
Returns:
`true` if and only if this class is an anonymous class.
Since:
1.5
* #### isLocalClass
public boolean isLocalClass()
Returns `true` if and only if the underlying class is a local class.
Returns:
`true` if and only if this class is a local class.
Since:
1.5
* #### isMemberClass
public boolean isMemberClass()
Returns `true` if and only if the underlying class is a member class.
Returns:
`true` if and only if this class is a member class.
Since:
1.5
* #### getClasses
public [Class](../../java/lang/Class.html "class in java.lang")<?>[] 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. This includes public class and interface members inherited from superclasses and public class and interface members declared by the class. This method returns an array of length 0 if this `Class` object has no public member classes or interfaces. This method also returns an array of length 0 if this `Class` object represents a primitive type, an array class, or void.
Returns:
the array of `Class` objects representing the public members of this class
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class.
Since:
1.1
* #### getFields
public [Field](../../java/lang/reflect/Field.html "class in java.lang.reflect")[] getFields()
throws [SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns an array containing `Field` objects reflecting all the accessible public fields of the class or interface represented by this `Class` object.
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.
Returns:
the array of `Field` objects representing the public fields
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class.
Since:
1.1
See The Java™ Language Specification:
8.2 Class Members, 8.3 Field Declarations
* #### getMethods
public [Method](../../java/lang/reflect/Method.html "class in java.lang.reflect")[] getMethods()
throws [SecurityException](../../java/lang/SecurityException.html "class in java.lang")
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.
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()](../../java/lang/Class.html#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.
API Note:
There may be more than one method with a particular name and parameter types in a class because while the Java language forbids a class to declare multiple methods with the same signature but different return types, the Java virtual machine does not. This increased flexibility in the virtual machine can be used to implement various language features. For example, covariant returns can be implemented with [bridge methods](../../java/lang/reflect/Method.html#isBridge--); the bridge method and the overriding method would have the same signature but different return types.
Returns:
the array of `Method` objects representing the public methods of this class
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class.
Since:
1.1
See The Java™ Language Specification:
8.2 Class Members, 8.4 Method Declarations
* #### getConstructors
public [Constructor](../../java/lang/reflect/Constructor.html "class in java.lang.reflect")<?>[] getConstructors()
throws [SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns an array containing `Constructor` objects reflecting all the public constructors of the class represented by this`Class` object. An array of length 0 is returned if the class has no public constructors, or if the class is an array class, or if the class reflects a primitive type or void. Note that while this method returns an array of ` Constructor<T>` objects (that is an array of constructors from this class), the return type of this method is ` Constructor<?>[]` and _not_ `Constructor<T>[]` as might be expected. This less informative return type is necessary since after being returned from this method, the array could be modified to hold `Constructor` objects for different classes, which would violate the type guarantees of`Constructor<T>[]`.
Returns:
the array of `Constructor` objects representing the public constructors of this class
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class.
Since:
1.1
* #### getField
public [Field](../../java/lang/reflect/Field.html "class in java.lang.reflect") getField([String](../../java/lang/String.html "class in java.lang") name)
throws [NoSuchFieldException](../../java/lang/NoSuchFieldException.html "class in java.lang"),
[SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns a `Field` object that reflects the specified public member field of the class or interface represented by this `Class` object. The `name` parameter is a `String` specifying the simple name of the desired field.
The field to be reflected is determined by the algorithm that follows. Let C be the class or interface represented by this 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.
Parameters:
`name` \- the field name
Returns:
the `Field` object of this class specified by`name`
Throws:
`[NoSuchFieldException](../../java/lang/NoSuchFieldException.html "class in java.lang")` \- if a field with the specified name is not found.
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if `name` is `null`
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class.
Since:
1.1
See The Java™ Language Specification:
8.2 Class Members, 8.3 Field Declarations
* #### getMethod
public [Method](../../java/lang/reflect/Method.html "class in java.lang.reflect") getMethod([String](../../java/lang/String.html "class in java.lang") name,
[Class](../../java/lang/Class.html "class in java.lang")<?>... parameterTypes)
throws [NoSuchMethodException](../../java/lang/NoSuchMethodException.html "class in java.lang"),
[SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns a `Method` object that reflects the specified public member method of the class or interface represented by this`Class` object. The `name` parameter is a`String` specifying the simple name of the desired method. The`parameterTypes` parameter is an array of `Class` objects that identify the method's formal parameter types, in declared order. If `parameterTypes` is `null`, it is treated as if it were an empty array.
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()](../../java/lang/Class.html#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<?>)](../../java/lang/Class.html#isAssignableFrom-java.lang.Class-)(S.class).
API Note:
There may be more than one method with matching name and parameter types in a class because while the Java language forbids a class to declare multiple methods with the same signature but different return types, the Java virtual machine does not. This increased flexibility in the virtual machine can be used to implement various language features. For example, covariant returns can be implemented with [bridge methods](../../java/lang/reflect/Method.html#isBridge--); the bridge method and the overriding method would have the same signature but different return types. This method would return the overriding method as it would have a more specific return type.
Parameters:
`name` \- the name of the method
`parameterTypes` \- the list of parameters
Returns:
the `Method` object that matches the specified`name` and `parameterTypes`
Throws:
`[NoSuchMethodException](../../java/lang/NoSuchMethodException.html "class in java.lang")` \- if a matching method is not found or if the name is "<init>"or "<clinit>".
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if `name` is `null`
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class.
Since:
1.1
See The Java™ Language Specification:
8.2 Class Members, 8.4 Method Declarations
* #### getConstructor
public [Constructor](../../java/lang/reflect/Constructor.html "class in java.lang.reflect")<[T](../../java/lang/Class.html "type parameter in Class")> getConstructor([Class](../../java/lang/Class.html "class in java.lang")<?>... parameterTypes)
throws [NoSuchMethodException](../../java/lang/NoSuchMethodException.html "class in java.lang"),
[SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns a `Constructor` object that reflects the specified public constructor of the class represented by this `Class` object. The `parameterTypes` parameter is an array of`Class` objects that identify the constructor's formal parameter types, in declared order. If this `Class` object represents an inner class declared in a non-static context, the formal parameter types include the explicit enclosing instance as the first parameter.
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`.
Parameters:
`parameterTypes` \- the parameter array
Returns:
the `Constructor` object of the public constructor that matches the specified `parameterTypes`
Throws:
`[NoSuchMethodException](../../java/lang/NoSuchMethodException.html "class in java.lang")` \- if a matching method is not found.
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class.
Since:
1.1
* #### getDeclaredClasses
public [Class](../../java/lang/Class.html "class in java.lang")<?>[] getDeclaredClasses()
throws [SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns an array of `Class` objects reflecting all the classes and interfaces declared as members of the class represented by this `Class` object. This includes public, protected, default (package) access, and private classes and interfaces declared by the class, but excludes inherited classes and interfaces. This method returns an array of length 0 if the class declares no classes or interfaces as members, or if this `Class` object represents a primitive type, an array class, or void.
Returns:
the array of `Class` objects representing all the declared members of this class
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and any of the following conditions is met:
* the caller's class loader is not the same as the class loader of this class and invocation of[s.checkPermission](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-) method with`RuntimePermission("accessDeclaredMembers")` denies access to the declared classes within this class
* the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class
Since:
1.1
* #### getDeclaredFields
public [Field](../../java/lang/reflect/Field.html "class in java.lang.reflect")[] getDeclaredFields()
throws [SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns an array of `Field` objects reflecting all the fields declared by the class or interface represented by this`Class` object. This includes public, protected, default (package) access, and private fields, but excludes inherited fields.
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.
Returns:
the array of `Field` objects representing all the declared fields of this class
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and any of the following conditions is met:
* the caller's class loader is not the same as the class loader of this class and invocation of[s.checkPermission](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-) method with`RuntimePermission("accessDeclaredMembers")` denies access to the declared fields within this class
* the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class
Since:
1.1
See The Java™ Language Specification:
8.2 Class Members, 8.3 Field Declarations
* #### getDeclaredMethods
public [Method](../../java/lang/reflect/Method.html "class in java.lang.reflect")[] getDeclaredMethods()
throws [SecurityException](../../java/lang/SecurityException.html "class in java.lang")
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.
If this `Class` object represents a type 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 type 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.
Returns:
the array of `Method` objects representing all the declared methods of this class
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and any of the following conditions is met:
* the caller's class loader is not the same as the class loader of this class and invocation of[s.checkPermission](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-) method with`RuntimePermission("accessDeclaredMembers")` denies access to the declared methods within this class
* the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class
Since:
1.1
See The Java™ Language Specification:
8.2 Class Members, 8.4 Method Declarations
* #### getDeclaredConstructors
public [Constructor](../../java/lang/reflect/Constructor.html "class in java.lang.reflect")<?>[] getDeclaredConstructors()
throws [SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns an array of `Constructor` objects reflecting all the constructors declared by the class represented by this`Class` object. These are public, protected, default (package) access, and private constructors. The elements in the array returned are not sorted and are not in any particular order. If the class has a default constructor, it is included in the returned array. This method returns an array of length 0 if this `Class` object represents an interface, a primitive type, an array class, or void.
See _The Java Language Specification_, section 8.2.
Returns:
the array of `Constructor` objects representing all the declared constructors of this class
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and any of the following conditions is met:
* the caller's class loader is not the same as the class loader of this class and invocation of[s.checkPermission](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-) method with`RuntimePermission("accessDeclaredMembers")` denies access to the declared constructors within this class
* the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class
Since:
1.1
* #### getDeclaredField
public [Field](../../java/lang/reflect/Field.html "class in java.lang.reflect") getDeclaredField([String](../../java/lang/String.html "class in java.lang") name)
throws [NoSuchFieldException](../../java/lang/NoSuchFieldException.html "class in java.lang"),
[SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns a `Field` object that reflects the specified declared field of the class or interface represented by this `Class` object. The `name` parameter is a `String` that specifies the simple name of the desired field.
If this `Class` object represents an array type, then this method does not find the `length` field of the array type.
Parameters:
`name` \- the name of the field
Returns:
the `Field` object for the specified field in this class
Throws:
`[NoSuchFieldException](../../java/lang/NoSuchFieldException.html "class in java.lang")` \- if a field with the specified name is not found.
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if `name` is `null`
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and any of the following conditions is met:
* the caller's class loader is not the same as the class loader of this class and invocation of[s.checkPermission](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-) method with`RuntimePermission("accessDeclaredMembers")` denies access to the declared field
* the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class
Since:
1.1
See The Java™ Language Specification:
8.2 Class Members, 8.3 Field Declarations
* #### getDeclaredMethod
public [Method](../../java/lang/reflect/Method.html "class in java.lang.reflect") getDeclaredMethod([String](../../java/lang/String.html "class in java.lang") name,
[Class](../../java/lang/Class.html "class in java.lang")<?>... parameterTypes)
throws [NoSuchMethodException](../../java/lang/NoSuchMethodException.html "class in java.lang"),
[SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns a `Method` object that reflects the specified declared method of the class or interface represented by this`Class` object. The `name` parameter is a`String` that specifies the simple name of the desired method, and the `parameterTypes` parameter is an array of`Class` objects that identify the method's formal parameter types, in declared order. If more than one method with the same parameter types is declared in a class, and one of these methods has a return type that is more specific than any of the others, that method is returned; otherwise one of the methods is chosen arbitrarily. If the name is "<init>"or "<clinit>" a `NoSuchMethodException` is raised.
If this `Class` object represents an array type, then this method does not find the `clone()` method.
Parameters:
`name` \- the name of the method
`parameterTypes` \- the parameter array
Returns:
the `Method` object for the method of this class matching the specified name and parameters
Throws:
`[NoSuchMethodException](../../java/lang/NoSuchMethodException.html "class in java.lang")` \- if a matching method is not found.
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if `name` is `null`
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and any of the following conditions is met:
* the caller's class loader is not the same as the class loader of this class and invocation of[s.checkPermission](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-) method with`RuntimePermission("accessDeclaredMembers")` denies access to the declared method
* the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class
Since:
1.1
See The Java™ Language Specification:
8.2 Class Members, 8.4 Method Declarations
* #### getDeclaredConstructor
public [Constructor](../../java/lang/reflect/Constructor.html "class in java.lang.reflect")<[T](../../java/lang/Class.html "type parameter in Class")> getDeclaredConstructor([Class](../../java/lang/Class.html "class in java.lang")<?>... parameterTypes)
throws [NoSuchMethodException](../../java/lang/NoSuchMethodException.html "class in java.lang"),
[SecurityException](../../java/lang/SecurityException.html "class in java.lang")
Returns a `Constructor` object that reflects the specified constructor of the class or interface represented by this`Class` object. The `parameterTypes` parameter is an array of `Class` objects that identify the constructor's formal parameter types, in declared order. If this `Class` object represents an inner class declared in a non-static context, the formal parameter types include the explicit enclosing instance as the first parameter.
Parameters:
`parameterTypes` \- the parameter array
Returns:
The `Constructor` object for the constructor with the specified parameter list
Throws:
`[NoSuchMethodException](../../java/lang/NoSuchMethodException.html "class in java.lang")` \- if a matching method is not found.
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- If a security manager, _s_, is present and any of the following conditions is met:
* the caller's class loader is not the same as the class loader of this class and invocation of[s.checkPermission](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-) method with`RuntimePermission("accessDeclaredMembers")` denies access to the declared constructor
* the caller's class loader is not the same as or an ancestor of the class loader for the current class and invocation of [s.checkPackageAccess()](../../java/lang/SecurityManager.html#checkPackageAccess-java.lang.String-) denies access to the package of this class
Since:
1.1
* #### getResourceAsStream
public [InputStream](../../java/io/InputStream.html "class in java.io") getResourceAsStream([String](../../java/lang/String.html "class in java.lang") name)
Finds a resource with a given name.
If this class is in a named [Module](../../java/lang/Module.html "class in java.lang") 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)](../../java/lang/ClassLoader.html#findResource-java.lang.String-java.lang.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 `Module` [getResourceAsStream](../../java/lang/Module.html#getResourceAsStream-java.lang.String-) 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](../../java/lang/ClassLoader.html "class in java.lang") of the class. This method delegates to this object's class loader. If this object was loaded by the bootstrap class loader, the method delegates to [ClassLoader.getSystemResourceAsStream(java.lang.String)](../../java/lang/ClassLoader.html#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'`).
Parameters:
`name` \- name of the desired resource
Returns:
A [InputStream](../../java/io/InputStream.html "class in java.io") object; `null` if no resource with this name is found, the resource is in a package that is not [open](../../java/lang/Module.html#isOpen-java.lang.String-java.lang.Module-) to at least the caller module, or access to the resource is denied by the security manager.
Throws:
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- If `name` is `null`
Since:
1.1
See Also:
[Module.getResourceAsStream(String)](../../java/lang/Module.html#getResourceAsStream-java.lang.String-)
* #### getResource
public [URL](../../java/net/URL.html "class in java.net") getResource([String](../../java/lang/String.html "class in java.lang") name)
Finds a resource with a given name.
If this class is in a named [Module](../../java/lang/Module.html "class in java.lang") 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)](../../java/lang/ClassLoader.html#findResource-java.lang.String-java.lang.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 `Module` [getResourceAsStream](../../java/lang/Module.html#getResourceAsStream-java.lang.String-) 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](../../java/lang/ClassLoader.html "class in java.lang") of the class. This method delegates to this object's class loader. If this object was loaded by the bootstrap class loader, the method delegates to [ClassLoader.getSystemResource(java.lang.String)](../../java/lang/ClassLoader.html#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'`).
Parameters:
`name` \- name of the desired resource
Returns:
A [URL](../../java/net/URL.html "class in java.net") 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](../../java/lang/Module.html#isOpen-java.lang.String-java.lang.Module-) to at least the caller module, or access to the resource is denied by the security manager.
Throws:
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- If `name` is `null`
Since:
1.1
* #### getProtectionDomain
public [ProtectionDomain](../../java/security/ProtectionDomain.html "class in java.security") getProtectionDomain()
Returns the `ProtectionDomain` of this class. If there is a security manager installed, this method first calls the security manager's `checkPermission` method with a`RuntimePermission("getProtectionDomain")` permission to ensure it's ok to get the`ProtectionDomain`.
Returns:
the ProtectionDomain of this class
Throws:
`[SecurityException](../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and its`checkPermission` method doesn't allow getting the ProtectionDomain.
Since:
1.2
See Also:
[ProtectionDomain](../../java/security/ProtectionDomain.html "class in java.security"), [SecurityManager.checkPermission(java.security.Permission)](../../java/lang/SecurityManager.html#checkPermission-java.security.Permission-), [RuntimePermission](../../java/lang/RuntimePermission.html "class in java.lang")
* #### desiredAssertionStatus
public boolean 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. If this class has had its assertion status set, the most recent setting will be returned; otherwise, if any package default assertion status pertains to this class, the most recent setting for the most specific pertinent package default assertion status is returned; otherwise, if this class is not a system class (i.e., it has a class loader) its class loader's default assertion status is returned; otherwise, the system class default assertion status is returned.
Few programmers will have any need for this method; it is provided for the benefit of the JRE itself. (It allows a class to determine at the time that it is initialized whether assertions should be enabled.) Note that this method is not guaranteed to return the actual assertion status that was (or will be) associated with the specified class when it was (or will be) initialized.
Returns:
the desired assertion status of the specified class.
Since:
1.4
See Also:
[ClassLoader.setClassAssertionStatus(java.lang.String, boolean)](../../java/lang/ClassLoader.html#setClassAssertionStatus-java.lang.String-boolean-), [ClassLoader.setPackageAssertionStatus(java.lang.String, boolean)](../../java/lang/ClassLoader.html#setPackageAssertionStatus-java.lang.String-boolean-), [ClassLoader.setDefaultAssertionStatus(boolean)](../../java/lang/ClassLoader.html#setDefaultAssertionStatus-boolean-)
* #### isEnum
public boolean isEnum()
Returns true if and only if this class was declared as an enum in the source code.
Returns:
true if and only if this class was declared as an enum in the source code
Since:
1.5
* #### getEnumConstants
public [T](../../java/lang/Class.html "type parameter in Class")[] getEnumConstants()
Returns the elements of this enum class or null if this Class object does not represent an enum type.
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 type
Since:
1.5
* #### cast
public [T](../../java/lang/Class.html "type parameter in Class") cast([Object](../../java/lang/Object.html "class in java.lang") obj)
Casts an object to the class or interface represented by this `Class` object.
Parameters:
`obj` \- the object to be cast
Returns:
the object after casting, or null if obj is null
Throws:
`[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang")` \- if the object is not null and is not assignable to the type T.
Since:
1.5
* #### asSubclass
public <U> [Class](../../java/lang/Class.html "class in java.lang")<? extends U> asSubclass([Class](../../java/lang/Class.html "class in java.lang")<U> clazz)
Casts this `Class` object to represent a subclass of the class represented by the specified class object. Checks that the cast is valid, and throws a `ClassCastException` if it is not. If this method succeeds, it always returns a reference to this class object.
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).
Type Parameters:
`U` \- the type to cast this class object to
Parameters:
`clazz` \- the class of the type to cast this class object to
Returns:
this `Class` object, cast to represent a subclass of the specified class object.
Throws:
`[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang")` \- if this `Class` object does not represent a subclass of the specified class (here "subclass" includes the class itself).
Since:
1.5
* #### getAnnotation
public <A extends [Annotation](../../java/lang/annotation/Annotation.html "interface in java.lang.annotation")> A getAnnotation([Class](../../java/lang/Class.html "class in java.lang")<A> annotationClass)
Returns this element's annotation for the specified type if such an annotation is _present_, else null.
Specified by:
`[getAnnotation](../../java/lang/reflect/AnnotatedElement.html#getAnnotation-java.lang.Class-)` in interface `[AnnotatedElement](../../java/lang/reflect/AnnotatedElement.html "interface in java.lang.reflect")`
Type Parameters:
`A` \- the type of the annotation to query for and return if present
Parameters:
`annotationClass` \- the Class object corresponding to the annotation type
Returns:
this element's annotation for the specified annotation type if present on this element, else null
Throws:
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the given annotation class is null
Since:
1.5
* #### isAnnotationPresent
public boolean isAnnotationPresent([Class](../../java/lang/Class.html "class in java.lang")<? extends [Annotation](../../java/lang/annotation/Annotation.html "interface in java.lang.annotation")> annotationClass)
Returns true if an annotation for the specified type is _present_ on this element, else false. This method is designed primarily for convenient access to marker annotations.
The truth value returned by this method is equivalent to:`getAnnotation(annotationClass) != null`
The body of the default method is specified to be the code above.
Specified by:
`[isAnnotationPresent](../../java/lang/reflect/AnnotatedElement.html#isAnnotationPresent-java.lang.Class-)` in interface `[AnnotatedElement](../../java/lang/reflect/AnnotatedElement.html "interface in java.lang.reflect")`
Parameters:
`annotationClass` \- the Class object corresponding to the annotation type
Returns:
true if an annotation for the specified annotation type is present on this element, else false
Throws:
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the given annotation class is null
Since:
1.5
* #### getAnnotationsByType
public <A extends [Annotation](../../java/lang/annotation/Annotation.html "interface in java.lang.annotation")> A[] getAnnotationsByType([Class](../../java/lang/Class.html "class in java.lang")<A> annotationClass)
Returns annotations that are _associated_ with this element. If there are no annotations _associated_ with this element, the return value is an array of length 0\. The difference between this method and [AnnotatedElement.getAnnotation(Class)](../../java/lang/reflect/AnnotatedElement.html#getAnnotation-java.lang.Class-) is that this method detects if its argument is a _repeatable annotation type_ (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.
Specified by:
`[getAnnotationsByType](../../java/lang/reflect/AnnotatedElement.html#getAnnotationsByType-java.lang.Class-)` in interface `[AnnotatedElement](../../java/lang/reflect/AnnotatedElement.html "interface in java.lang.reflect")`
Type Parameters:
`A` \- the type of the annotation to query for and return if present
Parameters:
`annotationClass` \- the Class object corresponding to the annotation type
Returns:
all this element's annotations for the specified annotation type if associated with this element, else an array of length zero
Throws:
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the given annotation class is null
Since:
1.8
* #### getAnnotations
public [Annotation](../../java/lang/annotation/Annotation.html "interface in java.lang.annotation")[] getAnnotations()
Returns annotations that are _present_ on this element. If there are no annotations _present_ on this element, the return value is an array of length 0\. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.
Specified by:
`[getAnnotations](../../java/lang/reflect/AnnotatedElement.html#getAnnotations--)` in interface `[AnnotatedElement](../../java/lang/reflect/AnnotatedElement.html "interface in java.lang.reflect")`
Returns:
annotations present on this element
Since:
1.5
* #### getDeclaredAnnotation
public <A extends [Annotation](../../java/lang/annotation/Annotation.html "interface in java.lang.annotation")> A getDeclaredAnnotation([Class](../../java/lang/Class.html "class in java.lang")<A> annotationClass)
Returns this element's annotation for the specified type if such an annotation is _directly present_, else null. This method ignores inherited annotations. (Returns null if no annotations are directly present on this element.)
Specified by:
`[getDeclaredAnnotation](../../java/lang/reflect/AnnotatedElement.html#getDeclaredAnnotation-java.lang.Class-)` in interface `[AnnotatedElement](../../java/lang/reflect/AnnotatedElement.html "interface in java.lang.reflect")`
Type Parameters:
`A` \- the type of the annotation to query for and return if directly present
Parameters:
`annotationClass` \- the Class object corresponding to the annotation type
Returns:
this element's annotation for the specified annotation type if directly present on this element, else null
Throws:
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the given annotation class is null
Since:
1.8
* #### getDeclaredAnnotationsByType
public <A extends [Annotation](../../java/lang/annotation/Annotation.html "interface in java.lang.annotation")> A[] getDeclaredAnnotationsByType([Class](../../java/lang/Class.html "class in java.lang")<A> annotationClass)
Returns this element's annotation(s) for the specified type if such annotations are either _directly present_ or_indirectly present_. This method ignores inherited annotations. If there are no specified annotations directly or indirectly present on this element, the return value is an array of length 0\. The difference between this method and [AnnotatedElement.getDeclaredAnnotation(Class)](../../java/lang/reflect/AnnotatedElement.html#getDeclaredAnnotation-java.lang.Class-) is that this method detects if its argument is a _repeatable annotation type_ (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation if one is present. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.
Specified by:
`[getDeclaredAnnotationsByType](../../java/lang/reflect/AnnotatedElement.html#getDeclaredAnnotationsByType-java.lang.Class-)` in interface `[AnnotatedElement](../../java/lang/reflect/AnnotatedElement.html "interface in java.lang.reflect")`
Type Parameters:
`A` \- the type of the annotation to query for and return if directly or indirectly present
Parameters:
`annotationClass` \- the Class object corresponding to the annotation type
Returns:
all this element's annotations for the specified annotation type if directly or indirectly present on this element, else an array of length zero
Throws:
`[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the given annotation class is null
Since:
1.8
* #### getDeclaredAnnotations
public [Annotation](../../java/lang/annotation/Annotation.html "interface in java.lang.annotation")[] getDeclaredAnnotations()
Returns annotations that are _directly present_ on this element. This method ignores inherited annotations. If there are no annotations _directly present_ on this element, the return value is an array of length 0\. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.
Specified by:
`[getDeclaredAnnotations](../../java/lang/reflect/AnnotatedElement.html#getDeclaredAnnotations--)` in interface `[AnnotatedElement](../../java/lang/reflect/AnnotatedElement.html "interface in java.lang.reflect")`
Returns:
annotations directly present on this element
Since:
1.5
* #### getAnnotatedSuperclass
public [AnnotatedType](../../java/lang/reflect/AnnotatedType.html "interface in java.lang.reflect") getAnnotatedSuperclass()
Returns an `AnnotatedType` object that represents the use of a type to specify the superclass of the entity represented by this ` Class` object. (The _use_ of type Foo to specify the superclass in '... extends Foo' is distinct from the _declaration_ of type Foo.)
If this `Class` object represents a type 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`.
Returns:
an object representing the superclass
Since:
1.8
* #### getAnnotatedInterfaces
public [AnnotatedType](../../java/lang/reflect/AnnotatedType.html "interface in java.lang.reflect")[] getAnnotatedInterfaces()
Returns an array of `AnnotatedType` objects that represent the use of types to specify superinterfaces of the entity represented by this`Class` object. (The _use_ of type Foo to specify a superinterface in '... implements Foo' is distinct from the_declaration_ of type Foo.)
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.
Returns:
an array representing the superinterfaces
Since:
1.8