org.mini2Dx.core

Interface Reflection

All Known Implementing Classes:

JvmReflection

public interface Reflection

Cross-platform reflection API

Method Summary

Modifier and Type	Method and Description
java.lang.Class	arrayComponentType(java.lang.Class clazz) Returns the class type of the elements of an array class
java.lang.Object	arrayGet(java.lang.Object array, int index) Returns the value of an index in an array
int	arrayLength(java.lang.Object array) Returns the length of an array
void	arraySet(java.lang.Object array, int index, java.lang.Object value) Sets the value of an index in an array
java.lang.Class	forName(java.lang.String qualifiedName) Returns the class/interface/annotation/etc.
Annotation	getAnnotation(java.lang.Class clazz, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Returns the specific annotation
Annotation[]	getAnnotations(java.lang.Class clazz) Returns declared and generated annotations that this class is annotated with
Constructor[]	getConstructors(java.lang.Class clazz) Returns an array of all (declared + compiler generated) constructors for a given class
Annotation	getDeclaredAnnotation(java.lang.Class clazz, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Returns
Annotation[]	getDeclaredAnnotations(java.lang.Class clazz) Returns declared annotations that this class is annotated with
Constructor[]	getDeclaredConstructors(java.lang.Class clazz) Returns an array of declared constructors for a given class
Field	getDeclaredField(java.lang.Class clazz, java.lang.String fieldName) Returns a declared field with a given name for a given class
Field[]	getDeclaredFields(java.lang.Class clazz) Returns an array of declared fields for a given class
Method[]	getDeclaredMethods(java.lang.Class clazz) Returns an array of declared methods for a given class
Field	getField(java.lang.Class clazz, java.lang.String fieldName) Returns a declared or compiler generated field with a given name for a given class
Field[]	getFields(java.lang.Class clazz) Returns an array of all (declared + compiler generated) fields for a given class
Method[]	getMethods(java.lang.Class clazz) Returns an array of all (declared + compiler generated) methods for a given class
boolean	isAbstract(java.lang.Class clazz) Returns if the provided class is an abstract class
boolean	isAnnotation(java.lang.Class clazz) Returns if the provided class is an annotation
boolean	isAnnotationPresent(java.lang.Class clazz, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Returns if the class is annotated with the provided annotation
boolean	isArray(java.lang.Class clazz) Returns if the provided class is an array
boolean	isAssignableFrom(java.lang.Class class1, java.lang.Class class2) Checks if the class1 is the same class, superclass or superinterface of class2
boolean	isEnum(java.lang.Class clazz) Returns if the provided class is an enum
boolean	isInstanceOf(java.lang.Class clazz, java.lang.Object obj) Checks if the provided object is an instance of the provided class
boolean	isInterface(java.lang.Class clazz) Returns if the provided class is an interface
boolean	isPrimitive(java.lang.Class clazz) Returns if the provided class is a primitive
java.lang.Object	newArray(java.lang.Class clazz, int size) Creates a new array of elements with the type of the given class
java.lang.Object	newInstance(java.lang.Class clazz) Creates a new instance of the provided class using the default constructor

Method Detail

forName

java.lang.Class forName(java.lang.String qualifiedName)
                 throws ReflectionException

Returns the class/interface/annotation/etc. associated with the given name

Parameters:

qualifiedName - The fully qualified name (e.g. java.lang.String)

Returns:

The Class

Throws:

ReflectionException - Thrown when the class cannot be found

newInstance

java.lang.Object newInstance(java.lang.Class clazz)
                      throws ReflectionException

Creates a new instance of the provided class using the default constructor

Parameters:

clazz - The class to create an instance of

Returns:

A new object instance

Throws:

ReflectionException - Thrown if the instance could not be created

isInstanceOf

boolean isInstanceOf(java.lang.Class clazz,
                     java.lang.Object obj)

Checks if the provided object is an instance of the provided class

Parameters:

clazz - The class to check

obj - The object to check

Returns:

True if obj is assignable to the provided class

isAssignableFrom

boolean isAssignableFrom(java.lang.Class class1,
                         java.lang.Class class2)

Checks if the class1 is the same class, superclass or superinterface of class2

Parameters:

class1 - See above

class2 - See above

Returns:

True if assignable

isAnnotationPresent

boolean isAnnotationPresent(java.lang.Class clazz,
                            java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Returns if the class is annotated with the provided annotation

Parameters:

clazz - The class to check

annotationType - The annotation to search for

Returns:

True if the class is annotated with the provided annotation

getAnnotations

Annotation[] getAnnotations(java.lang.Class clazz)

Returns declared and generated annotations that this class is annotated with

Parameters:

clazz - The class to check

Returns:

An empty array if no annotations

getAnnotation

Annotation getAnnotation(java.lang.Class clazz,
                         java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Returns the specific annotation

Parameters:

clazz - The class to check

annotationType -

Returns:

getDeclaredAnnotations

Annotation[] getDeclaredAnnotations(java.lang.Class clazz)

Returns declared annotations that this class is annotated with

Parameters:

clazz - The class to check

Returns:

An empty array if no annotations

getDeclaredAnnotation

Annotation getDeclaredAnnotation(java.lang.Class clazz,
                                 java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Returns

Parameters:

clazz - The class to check

annotationType -

Returns:

getConstructors

Constructor[] getConstructors(java.lang.Class clazz)

Returns an array of all (declared + compiler generated) constructors for a given class

Parameters:

clazz - The clazz to get constructors from

Returns:

A non-zero sized array of constructors

getDeclaredConstructors

Constructor[] getDeclaredConstructors(java.lang.Class clazz)

Returns an array of declared constructors for a given class

Parameters:

clazz - The clazz to get constructors from

Returns:

An empty array if there are no declared constructors

getMethods

Method[] getMethods(java.lang.Class clazz)

Returns an array of all (declared + compiler generated) methods for a given class

Parameters:

clazz - The clazz to get methods from

Returns:

An empty array if no methods

getDeclaredMethods

Method[] getDeclaredMethods(java.lang.Class clazz)

Returns an array of declared methods for a given class

Parameters:

clazz - The clazz to get methods from

Returns:

An empty array if no declared methods

getFields

Field[] getFields(java.lang.Class clazz)

Returns an array of all (declared + compiler generated) fields for a given class

Parameters:

clazz - The clazz to get fields from

Returns:

An empty array if no fields

getDeclaredFields

Field[] getDeclaredFields(java.lang.Class clazz)

Returns an array of declared fields for a given class

Parameters:

clazz - The clazz to get fields from

Returns:

An empty array if no declared fields

getField

Field getField(java.lang.Class clazz,
               java.lang.String fieldName)
        throws ReflectionException

Returns a declared or compiler generated field with a given name for a given class

Parameters:

clazz - The clazz to get the field from

fieldName - The field name to retrieve

Returns:

The Field instance

Throws:

ReflectionException - Thrown if the field does not exist

getDeclaredField

Field getDeclaredField(java.lang.Class clazz,
                       java.lang.String fieldName)
                throws ReflectionException

Returns a declared field with a given name for a given class

Parameters:

clazz - The clazz to get the field from

fieldName - The field name to retrieve

Returns:

The Field instance

Throws:

ReflectionException - Thrown if the field does not exist

isAbstract

boolean isAbstract(java.lang.Class clazz)

Returns if the provided class is an abstract class

Parameters:

clazz - The class to check

Returns:

True if abstract

isInterface

boolean isInterface(java.lang.Class clazz)

Returns if the provided class is an interface

Parameters:

clazz - The class to check

Returns:

True if interface

isEnum

boolean isEnum(java.lang.Class clazz)

Returns if the provided class is an enum

Parameters:

clazz - The class to check

Returns:

True if interface

isPrimitive

boolean isPrimitive(java.lang.Class clazz)

Returns if the provided class is a primitive

Parameters:

clazz - The class to check

Returns:

True if primitive

isAnnotation

boolean isAnnotation(java.lang.Class clazz)

Returns if the provided class is an annotation

Parameters:

clazz - The class to check

Returns:

True if annotation

isArray

boolean isArray(java.lang.Class clazz)

Returns if the provided class is an array

Parameters:

clazz - The class to check

Returns:

True if array

arrayComponentType

java.lang.Class arrayComponentType(java.lang.Class clazz)

Returns the class type of the elements of an array class

Parameters:

clazz - An array class

Returns:

Null if a non-array class is provided

arrayGet

java.lang.Object arrayGet(java.lang.Object array,
                          int index)

Returns the value of an index in an array

Parameters:

array - The array instance

index - The index

Returns:

The object at the index or null if no object

arraySet

void arraySet(java.lang.Object array,
              int index,
              java.lang.Object value)

Sets the value of an index in an array

Parameters:

array - The array instance

index - The index

value - The value

arrayLength

int arrayLength(java.lang.Object array)

Returns the length of an array

Parameters:

array - The array instance

Returns:

The array length

newArray

java.lang.Object newArray(java.lang.Class clazz,
                          int size)

Creates a new array of elements with the type of the given class

Parameters:

clazz - The array element type

size - The size of the array

Returns:

A new array instance