ReflectionUtils (Morphia 1.2.1-SNAPSHOT API)

java.lang.Object
- org.mongodb.morphia.utils.ReflectionUtils

```
public final class ReflectionUtils
extends Object
```
Various reflection utility methods, used mainly in the Mapper.

Author:

Olafur Gauti Gudmundsson

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Object`	`convertToArray(Class type, List<?> values)` Converts a List to an array
`static <T> T`	`getAnnotation(Class c, Class<T> annotation)` Returns an annotation on a Class if present
`static <T> List<T>`	`getAnnotations(Class c, Class<T> annotation)` Returns the (first) instance of the annotation, on the class (or any superclass, or interfaces implemented).
`static Class<?>`	`getClass(Type type)` Get the underlying class for a type, or null if the type is a variable type.
`static Embedded`	`getClassEmbeddedAnnotation(Class c)` Returns the @Embedded annotation on a Class if present
`static Entity`	`getClassEntityAnnotation(Class c)` Returns the @Entity annotation on a Class if present
`static Set<Class<?>>`	`getClasses(ClassLoader loader, String packageName)` Returns the classes in a package
`static Set<Class<?>>`	`getClasses(ClassLoader loader, String packageName, boolean mapSubPackages)` Returns the classes in a package
`static Set<Class<?>>`	`getClasses(String packageName)` Returns the classes in a package
`static Set<Class<?>>`	`getClasses(String packageName, boolean mapSubPackages)` Returns the classes in a package
`static Field[]`	`getDeclaredAndInheritedFields(Class type, boolean returnFinalFields)` Get an array of all fields declared in the supplied class, and all its superclasses (except java.lang.Object).
`static List<Method>`	`getDeclaredAndInheritedMethods(Class type)` Get a list of all methods declared in the supplied class, and all its superclasses (except java.lang.Object), recursively.
`static Set<Class<?>>`	`getFromDirectory(ClassLoader loader, File directory, String packageName)` Returns the classes in a package found in a directory
`static Set<Class<?>>`	`getFromDirectory(ClassLoader loader, File directory, String packageName, boolean mapSubPackages)` Returns the classes in a package found in a directory
`static Set<Class<?>>`	`getFromJARFile(ClassLoader loader, String jar, String packageName)` Returns the classes in a package found in a jar
`static Set<Class<?>>`	`getFromJARFile(ClassLoader loader, String jar, String packageName, boolean mapSubPackages)` Returns the classes in a package found in a jar
`static Class`	`getParameterizedClass(Class c)` Returns the parameterized type of a Class
`static Class`	`getParameterizedClass(Class c, int index)` Returns the parameterized type in the given position
`static Class`	`getParameterizedClass(Field field)` Get the (first) class that parameterizes the Field supplied.
`static Class`	`getParameterizedClass(Field field, int index)` Get the class that parameterizes the Field supplied, at the index supplied (field can be parameterized with multiple param classes).
`static Type`	`getParameterizedType(Field field, int index)` Returns the parameterized type for a field
`static <T> Class<?>`	`getTypeArgument(Class<? extends T> clazz, TypeVariable<? extends GenericDeclaration> tv)` Returns the type argument
`static <T> List<Class<?>>`	`getTypeArguments(Class<T> baseClass, Class<? extends T> childClass)` Deprecated. this class is unused in morphia and will be removed in a future release
`static List<Field>`	`getValidFields(Field[] fields, boolean returnFinalFields)` Scans the array fields and returns any fields that are not static or (optionally) final.
`static boolean`	`implementsInterface(Class<?> type, Class<?> interfaceClass)` Check if a class implements a specific interface.
`static boolean`	`isFieldParameterizedWithClass(Field field, Class c)` Deprecated. this class is unused in morphia and will be removed in a future release
`static boolean`	`isFieldParameterizedWithPropertyType(Field field)` Deprecated. this class is unused in morphia and will be removed in a future release
`static boolean`	`isIntegerType(Class type)` Checks if the class is an integer type, i.e., is numeric but not a floating point type.
`static boolean`	`isPrimitiveLike(Class type)` Checks if the Class given is a primitive type.
`static boolean`	`isPropertyType(Class type)` Checks if the Class given is a property type
`static boolean`	`isPropertyType(Type type)` Check if the class supplied represents a valid property type.
`static <T> List<T>`	`iterToList(Iterable<T> it)` Converts an Iterable to a List

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getDeclaredAndInheritedFields
```
public static Field[] getDeclaredAndInheritedFields(Class type,
                                                    boolean returnFinalFields)
```
    Get an array of all fields declared in the supplied class, and all its superclasses (except java.lang.Object).
    
    Parameters:
    
    type - the class for which we want to retrieve the Fields
    
    returnFinalFields - specifies whether to return final fields
    
    Returns:
    
    an array of all declared and inherited fields
  - getValidFields
```
public static List<Field> getValidFields(Field[] fields,
                                         boolean returnFinalFields)
```
    Scans the array fields and returns any fields that are not static or (optionally) final.
    
    Parameters:
    
    fields - the fields to process
    
    returnFinalFields - include final fields in the results
    
    Returns:
    
    the valid fields
  - getDeclaredAndInheritedMethods
```
public static List<Method> getDeclaredAndInheritedMethods(Class type)
```
    Get a list of all methods declared in the supplied class, and all its superclasses (except java.lang.Object), recursively.
    
    Parameters:
    
    type - the class for which we want to retrieve the Methods
    
    Returns:
    
    an array of all declared and inherited fields
  - isIntegerType
```
public static boolean isIntegerType(Class type)
```
    Checks if the class is an integer type, i.e., is numeric but not a floating point type.
    
    Parameters:
    
    type - the class we want to check
    
    Returns:
    
    true if the type is an integral type
  - isPropertyType
```
public static boolean isPropertyType(Type type)
```
    Check if the class supplied represents a valid property type.
    
    Parameters:
    
    type - the class we want to check
    
    Returns:
    
    true if the class represents a valid property type
  - getParameterizedClass
```
public static Class getParameterizedClass(Field field)
```
    Get the (first) class that parameterizes the Field supplied.
    
    Parameters:
    
    field - the field
    
    Returns:
    
    the class that parameterizes the field, or null if field is not parameterized
  - getParameterizedClass
```
public static Class getParameterizedClass(Field field,
                                          int index)
```
    Get the class that parameterizes the Field supplied, at the index supplied (field can be parameterized with multiple param classes).
    
    Parameters:
    
    field - the field
    
    index - the index of the parameterizing class
    
    Returns:
    
    the class that parameterizes the field, or null if field is not parameterized
  - getParameterizedType
```
public static Type getParameterizedType(Field field,
                                        int index)
```
    Returns the parameterized type for a field
    
    Parameters:
    
    field - the field to examine
    
    index - the location of the parameter to return
    
    Returns:
    
    the type
  - getParameterizedClass
```
public static Class getParameterizedClass(Class c)
```
    Returns the parameterized type of a Class
    
    Parameters:
    
    c - the class to examine
    
    Returns:
    
    the type
  - getParameterizedClass
```
public static Class getParameterizedClass(Class c,
                                          int index)
```
    Returns the parameterized type in the given position
    
    Parameters:
    
    c - the class to examine
    
    index - the position of the type to return
    
    Returns:
    
    the type
  - isFieldParameterizedWithClass
```
public static boolean isFieldParameterizedWithClass(Field field,
                                                    Class c)
```
    Deprecated. this class is unused in morphia and will be removed in a future release
    
    Check if a field is parameterized with a specific class.
    
    Parameters:
    
    field - the field
    
    c - the class to check against
    
    Returns:
    
    true if the field is parameterized and c is the class that parameterizes the field, or is an interface that the parameterized class implements, else false
  - implementsInterface
```
public static boolean implementsInterface(Class<?> type,
                                          Class<?> interfaceClass)
```
    Check if a class implements a specific interface.
    
    Parameters:
    
    type - the class we want to check
    
    interfaceClass - the interface class we want to check against
    
    Returns:
    
    true if type implements interfaceClass, else false
  - isFieldParameterizedWithPropertyType
```
public static boolean isFieldParameterizedWithPropertyType(Field field)
```
    Deprecated. this class is unused in morphia and will be removed in a future release
    
    Check if the field supplied is parameterized with a valid JCR property type.
    
    Parameters:
    
    field - the field
    
    Returns:
    
    true if the field is parameterized with a valid JCR property type, else false
  - isPropertyType
```
public static boolean isPropertyType(Class type)
```
    Checks if the Class given is a property type
    
    Parameters:
    
    type - the Class to examine
    
    Returns:
    
    true if the Class's type is considered a property type
  - isPrimitiveLike
```
public static boolean isPrimitiveLike(Class type)
```
    Checks if the Class given is a primitive type. This includes the Java primitive types and their wrapper types.
    
    Parameters:
    
    type - the Class to examine
    
    Returns:
    
    true if the Class's type is considered a primitive type
  - getClassEmbeddedAnnotation
```
public static Embedded getClassEmbeddedAnnotation(Class c)
```
    Returns the @Embedded annotation on a Class if present
    
    Parameters:
    
    c - the class to examine
    
    Returns:
    
    the annotation. may be null.
  - getAnnotation
```
public static <T> T getAnnotation(Class c,
                                  Class<T> annotation)
```
    Returns an annotation on a Class if present
    
    Type Parameters:
    
    T - the type of the annotation
    
    Parameters:
    
    c - the class to examine
    
    annotation - the annotation to find
    
    Returns:
    
    the annotation. may be null.
  - getAnnotations
```
public static <T> List<T> getAnnotations(Class c,
                                         Class<T> annotation)
```
    Returns the (first) instance of the annotation, on the class (or any superclass, or interfaces implemented).
    
    Type Parameters:
    
    T - the type of the annotation
    
    Parameters:
    
    c - the class to examine
    
    annotation - the annotation to find
    
    Returns:
    
    the list of annotations
  - getClassEntityAnnotation
```
public static Entity getClassEntityAnnotation(Class c)
```
    Returns the @Entity annotation on a Class if present
    
    Parameters:
    
    c - the class to examine
    
    Returns:
    
    the annotation. may be null.
  - getClasses
```
public static Set<Class<?>> getClasses(String packageName)
                                throws IOException,
                                       ClassNotFoundException
```
    Returns the classes in a package
    
    Parameters:
    
    packageName - the package to scan
    
    Returns:
    
    the list of classes
    
    Throws:
    
    IOException - thrown if an error is encountered scanning packages
    
    ClassNotFoundException - thrown if a class can not be found
  - getClasses
```
public static Set<Class<?>> getClasses(String packageName,
                                       boolean mapSubPackages)
                                throws IOException,
                                       ClassNotFoundException
```
    Returns the classes in a package
    
    Parameters:
    
    packageName - the package to scan
    
    mapSubPackages - whether to map the sub-packages while scanning
    
    Returns:
    
    the list of classes
    
    Throws:
    
    IOException - thrown if an error is encountered scanning packages
    
    ClassNotFoundException - thrown if a class can not be found
  - getClasses
```
public static Set<Class<?>> getClasses(ClassLoader loader,
                                       String packageName)
                                throws IOException,
                                       ClassNotFoundException
```
    Returns the classes in a package
    
    Parameters:
    
    loader - the ClassLoader to use
    
    packageName - the package to scan
    
    Returns:
    
    the list of classes
    
    Throws:
    
    IOException - thrown if an error is encountered scanning packages
    
    ClassNotFoundException - thrown if a class can not be found
  - getClasses
```
public static Set<Class<?>> getClasses(ClassLoader loader,
                                       String packageName,
                                       boolean mapSubPackages)
                                throws IOException,
                                       ClassNotFoundException
```
    Returns the classes in a package
    
    Parameters:
    
    loader - the ClassLoader to use
    
    packageName - the package to scan
    
    mapSubPackages - whether to map the sub-packages while scanning
    
    Returns:
    
    the list of classes
    
    Throws:
    
    IOException - thrown if an error is encountered scanning packages
    
    ClassNotFoundException - thrown if a class can not be found
  - getFromJARFile
```
public static Set<Class<?>> getFromJARFile(ClassLoader loader,
                                           String jar,
                                           String packageName)
                                    throws IOException,
                                           ClassNotFoundException
```
    Returns the classes in a package found in a jar
    
    Parameters:
    
    loader - the ClassLoader to use
    
    jar - the jar to scan
    
    packageName - the package to scan
    
    Returns:
    
    the list of classes
    
    Throws:
    
    IOException - thrown if an error is encountered scanning packages
    
    ClassNotFoundException - thrown if a class can not be found
  - getFromJARFile
```
public static Set<Class<?>> getFromJARFile(ClassLoader loader,
                                           String jar,
                                           String packageName,
                                           boolean mapSubPackages)
                                    throws IOException,
                                           ClassNotFoundException
```
    Returns the classes in a package found in a jar
    
    Parameters:
    
    loader - the ClassLoader to use
    
    jar - the jar to scan
    
    packageName - the package to scan
    
    mapSubPackages - whether to map the sub-packages while scanning
    
    Returns:
    
    the list of classes
    
    Throws:
    
    IOException - thrown if an error is encountered scanning packages
    
    ClassNotFoundException - thrown if a class can not be found
  - getFromDirectory
```
public static Set<Class<?>> getFromDirectory(ClassLoader loader,
                                             File directory,
                                             String packageName)
                                      throws ClassNotFoundException
```
    Returns the classes in a package found in a directory
    
    Parameters:
    
    loader - the ClassLoader to use
    
    directory - the directory to scan
    
    packageName - the package to scan
    
    Returns:
    
    the list of classes
    
    Throws:
    
    ClassNotFoundException - thrown if a class can not be found
  - getFromDirectory
```
public static Set<Class<?>> getFromDirectory(ClassLoader loader,
                                             File directory,
                                             String packageName,
                                             boolean mapSubPackages)
                                      throws ClassNotFoundException
```
    Returns the classes in a package found in a directory
    
    Parameters:
    
    loader - the ClassLoader to use
    
    directory - the directory to scan
    
    packageName - the package to scan
    
    mapSubPackages - whether to map the sub-packages while scanning
    
    Returns:
    
    the list of classes
    
    Throws:
    
    ClassNotFoundException - thrown if a class can not be found
  - iterToList
```
public static <T> List<T> iterToList(Iterable<T> it)
```
    Converts an Iterable to a List
    
    Type Parameters:
    
    T - the types of the elements in the Iterable
    
    Parameters:
    
    it - the Iterable
    
    Returns:
    
    the List
  - convertToArray
```
public static Object convertToArray(Class type,
                                    List<?> values)
```
    Converts a List to an array
    
    Parameters:
    
    type - the Class type of the elements of the List
    
    values - the List to convert
    
    Returns:
    
    the array
  - getClass
```
public static Class<?> getClass(Type type)
```
    Get the underlying class for a type, or null if the type is a variable type.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the underlying class
  - getTypeArguments
```
public static <T> List<Class<?>> getTypeArguments(Class<T> baseClass,
                                                  Class<? extends T> childClass)
```
    Deprecated. this class is unused in morphia and will be removed in a future release
    
    Get the actual type arguments a child class has used to extend a generic base class.
    
    Type Parameters:
    
    T - the type of the base class
    
    Parameters:
    
    baseClass - the base class
    
    childClass - the child class
    
    Returns:
    
    a list of the raw classes for the actual type arguments.
  - getTypeArgument
```
public static <T> Class<?> getTypeArgument(Class<? extends T> clazz,
                                           TypeVariable<? extends GenericDeclaration> tv)
```
    Returns the type argument
    
    Type Parameters:
    
    T - the type of the Class
    
    Parameters:
    
    clazz - the Class to examine
    
    tv - the TypeVariable to look for
    
    Returns:
    
    the Class type

Class ReflectionUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDeclaredAndInheritedFields

getValidFields

getDeclaredAndInheritedMethods

isIntegerType

isPropertyType

getParameterizedClass

getParameterizedClass

getParameterizedType

getParameterizedClass

getParameterizedClass

isFieldParameterizedWithClass

implementsInterface

isFieldParameterizedWithPropertyType

isPropertyType

isPrimitiveLike

getClassEmbeddedAnnotation

getAnnotation

getAnnotations

getClassEntityAnnotation

getClasses

getClasses

getClasses

getClasses

getFromJARFile

getFromJARFile

getFromDirectory

getFromDirectory

iterToList

convertToArray

getClass

getTypeArguments

getTypeArgument