Class

arrayType

fun arrayType(): Class<*>

Returns a Class for an array type whose component type is described by this Class.

asSubclass

fun <U : Any!> asSubclass(clazz: Class<U>): Class<out U>

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).

cast

fun cast(obj: Any?): T?

Casts an object to the class or interface represented by this Class object.

componentType

fun componentType(): Class<*>?

Returns the component type of this Class, if it describes an array type, or null otherwise.

descriptorString

fun descriptorString(): String

Returns the descriptor string of the entity (class, interface, array class, primitive type, or void) represented by this Class object.

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

• The result is a field descriptor (JVMS {@jvms 4.3.2}) for the class or interface.

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.

• This array class can be described nominally.

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 {@jvms 4.3.2}).

desiredAssertionStatus

fun desiredAssertionStatus(): Boolean

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.

forName

static fun forName(className: String): Class<*>

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:

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

forName

static fun forName(
    name: String, 
    initialize: Boolean, 
    loader: ClassLoader?
): Class<*>

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 and load 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:

getAnnotation

fun <A : Annotation!> getAnnotation(annotationClass: Class<A>): A?

Returns this element's annotation for the specified type if such an annotation is present, else null.

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

getAnnotations

fun getAnnotations(): Array<Annotation!>

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.

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

getAnnotationsByType

fun <A : Annotation!> getAnnotationsByType(annotationClass: Class<A>): Array<A>

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 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.

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

getCanonicalName

fun getCanonicalName(): String?

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. Classes without canonical names include:

• a local class
• a anonymous class
• an array whose component type does not have a canonical name

getClassLoader

fun getClassLoader(): ClassLoader?

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 Class object represents a primitive type or void, null is returned.

getClasses

fun getClasses(): Array<Class<*>!>

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.

getComponentType

fun getComponentType(): Class<*>?

Returns the Class representing the component type of an array. If this class does not represent an array class this method returns null.

getConstructor

fun getConstructor(vararg parameterTypes: Class<*>!): Constructor<T>

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.

getConstructors

fun getConstructors(): Array<Constructor<*>!>

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.

getDeclaredAnnotation

fun <A : Annotation!> getDeclaredAnnotation(annotationClass: Class<A>): A?

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.)

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

getDeclaredAnnotations

fun getDeclaredAnnotations(): Array<Annotation!>

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.

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

getDeclaredAnnotationsByType

fun <A : Annotation!> getDeclaredAnnotationsByType(annotationClass: Class<A>): Array<A>

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 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.

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

getDeclaredClasses

fun getDeclaredClasses(): Array<Class<*>!>

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.

getDeclaredConstructor

fun getDeclaredConstructor(vararg parameterTypes: Class<*>!): Constructor<T>

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.

getDeclaredConstructors

fun getDeclaredConstructors(): Array<Constructor<*>!>

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 {@jls 8.2}.

getDeclaredField

fun getDeclaredField(name: String): Field

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.

getDeclaredFields

fun getDeclaredFields(): Array<Field!>

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.

getDeclaredMethod

fun getDeclaredMethod(
    name: String, 
    vararg parameterTypes: Class<*>!
): Method

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.

getDeclaredMethods

fun getDeclaredMethods(): Array<Method!>

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. The declared methods may include methods not in the source of the class or interface, including bridge methods and other synthetic methods added by compilers.

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.

getDeclaringClass

fun getDeclaringClass(): Class<*>?

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.

getEnclosingClass

fun getEnclosingClass(): Class<*>?

Returns the immediately enclosing class of the underlying class. If the underlying class is a top level class this method returns null.

getEnclosingConstructor

fun getEnclosingConstructor(): Constructor<*>?

If this Class object represents a local or anonymous class within a constructor, returns a 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 class or interface declaration, instance initializer or static initializer.

getEnclosingMethod

fun getEnclosingMethod(): Method?

If this Class object represents a local or anonymous class within a method, returns a 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 class or interface declaration, instance initializer or static initializer.

getEnumConstants

fun getEnumConstants(): Array<T>?

Returns the elements of this enum class or null if this Class object does not represent an enum class.

getField

fun getField(name: String): Field

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 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.

getFields

fun getFields(): Array<Field!>

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.

getGenericInterfaces

fun getGenericInterfaces(): Array<Type!>

Returns the Types representing the interfaces directly implemented by the class or interface represented by this Class object.

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.

getGenericSuperclass

fun getGenericSuperclass(): Type?

Returns the Type representing the direct superclass of the entity (class, interface, primitive type or void) represented by this Class object.

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 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.

getInterfaces

fun getInterfaces(): Array<Class<*>!>

Returns the interfaces directly implemented by the class or interface represented by this object.

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:

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.

getMethod

fun getMethod(
    name: String, 
    vararg parameterTypes: Class<*>!
): Method

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() 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(S.class).

getMethods

fun getMethods(): Array<Method!>

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() 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.

getModifiers

fun getModifiers(): Int

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 object represents a primitive type or void, its public modifier is always true, and its protected and private modifiers are always false. If this Class 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 section {@jvms 4.1} of The Java Virtual Machine Specification.

getName

fun getName(): String

Returns the name of the entity (class, interface, array class, primitive type, or void) represented by this Class object.

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

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:

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"
  

getNestHost

fun getNestHost(): Class<*>

Returns the nest host of the nest to which the class or interface represented by this Class object belongs. Every class and interface belongs to exactly one nest. If the nest host of this class or interface has previously been determined, then this method returns the nest host. If the nest host of this class or interface has not previously been determined, then this method determines the nest host using the algorithm of JVMS 5.4.4, and returns it. Often, a class or interface belongs to a nest consisting only of itself, in which case this method returns this to indicate that the class or interface is the nest host.

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.

getNestMembers

fun getNestMembers(): Array<Class<*>!>

Returns an array containing Class objects representing all the classes and interfaces that are members of the nest to which the class or interface represented by this Class object belongs. First, this method obtains the nest host, H, of the nest to which the class or interface represented by this Class object belongs. The zeroth element of the returned array is H. Then, for each class or interface C which is recorded by H as being a member of its nest, this method attempts to obtain the Class object for C (using the defining class of the current Class object), and then obtains the nest host of the nest to which C belongs. The classes and interfaces which are recorded by H as being members of its nest, and for which H can be determined as their nest host, are indicated by subsequent elements of the returned array. The order of such elements is unspecified. Duplicates are permitted.

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

getPackage

fun getPackage(): Package?

Gets the package of this class.

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

getPackageName

fun getPackageName(): String

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.

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.

getPermittedSubclasses

fun getPermittedSubclasses(): Array<Class<*>!>?

Returns an array containing Class objects representing the direct subinterfaces or subclasses permitted to extend or implement this class or interface if it is sealed. The order of such elements is unspecified. The array is empty if this sealed class or interface has no permitted subclass. If this Class object represents a primitive type, void, an array type, or a class or interface that is not sealed, that is isSealed() returns false, then this method returns null. Conversely, if isSealed() returns true, then this method returns a non-null value. For each class or interface C which is recorded as a permitted direct subinterface or subclass of this class or interface, this method attempts to obtain the Class object for C (using the defining class of the current Class object). The Class objects which can be obtained and which are direct subinterfaces or subclasses of this class or interface, are indicated by elements of the returned array. If a Class object cannot be obtained, it is silently ignored, and not included in the result array.

getProtectionDomain

fun getProtectionDomain(): ProtectionDomain?

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.

getRecordComponents

fun getRecordComponents(): Array<RecordComponent!>?

Returns an array of RecordComponent objects representing all the record components of this record class, or null if this class is not a record class.

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.

getResource

fun getResource(name: String): URL?

Finds a resource with a given name.

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.

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').

getResourceAsStream

fun getResourceAsStream(name: String): InputStream?

Finds a resource with a given name.

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.

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').

getSigners

fun getSigners(): Array<Any!>?

Gets the signers of this class.

getSimpleName

fun getSimpleName(): String

Returns the simple name of the underlying class as given in the source code. An empty string is returned if the underlying class is anonymous. A synthetic class, one not present in source code, can have a non-empty name including special characters, such as "$".

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 "[]".

getSuperclass

fun getSuperclass(): Class<in T>?

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 Class object represents an array class then the Class object representing the Object class is returned.

getTypeName

fun getTypeName(): String

Return an informative string for the name of this class or interface.

getTypeParameters

fun getTypeParameters(): Array<TypeVariable<Class<T>!>!>

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.

isAnnotation

fun isAnnotation(): Boolean

Returns true if this Class object represents an annotation interface. Note that if this method returns true, isInterface() would also return true, as all annotation interfaces are also interfaces.

isAnnotationPresent

fun isAnnotationPresent(annotationClass: Class<out Annotation!>): Boolean

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.

isAnonymousClass

fun isAnonymousClass(): Boolean

Returns true if and only if the underlying class is an anonymous class.

isArray

fun isArray(): Boolean

Determines if this Class object represents an array class.

isAssignableFrom

fun isAssignableFrom(cls: Class<*>): Boolean

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 {@jls 5.1.1} and {@jls 5.1.4}, for details.

isEnum

fun isEnum(): Boolean

Returns true if and only if this class was declared as an enum in the source code. Note that java.lang.Enum is not itself an enum class. Also note that if an enum constant is declared with a class body, the class of that enum constant object is an anonymous class and not the class of the declaring enum class. The Enum.getDeclaringClass method of an enum constant can be used to get the class of the enum class declaring the constant.

isInstance

fun isInstance(obj: Any?): Boolean

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.

isInterface

fun isInterface(): Boolean

Determines if this Class object represents an interface type.

isLocalClass

fun isLocalClass(): Boolean

Returns true if and only if the underlying class is a local class.

isMemberClass

fun isMemberClass(): Boolean

Returns true if and only if the underlying class is a member class.

isNestmateOf

fun isNestmateOf(c: Class<*>): Boolean

Determines if the given Class is a nestmate of the class or interface represented by this Class object. Two classes or interfaces are nestmates if they have the same nest host.

isPrimitive

fun isPrimitive(): Boolean

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.

isRecord

fun isRecord(): Boolean

Returns true if and only if this class is a record class.

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.

isSealed

fun isSealed(): Boolean

Returns true if and only if this Class object represents a sealed class or interface. If this Class object represents a primitive type, void, or an array type, this method returns false. A sealed class or interface has (possibly zero) permitted subclasses; getPermittedSubclasses() returns a non-null but possibly empty value for a sealed class or interface.

isSynthetic

fun isSynthetic(): Boolean

{@return {@code true} if and only if this class has the synthetic modifier * bit set}

newInstance

fun newInstance(): T

Deprecated: This method propagates any exception thrown by the nullary constructor, including a checked exception. Use of this method effectively bypasses the compile-time exception checking that would otherwise be performed by the compiler. The Constructor.newInstance method avoids this problem by wrapping any exception thrown by the constructor in a (checked) .

The call

<code>clazz.newInstance()
  </code>

<code>clazz.getDeclaredConstructor().newInstance()
  </code>

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.

toGenericString

fun toGenericString(): String

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, @interface, or record as appropriate), followed by the type's name, followed by an angle-bracketed comma-separated list of the type's type parameters, if any, including informative bounds on the 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.

toString

fun toString(): String

Converts the object to a string. The string representation is the string "class" or "interface", followed by a space, and then by the 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.