GenericTypeReflector (GeAnTyRef 1.0.0 API)

java.lang.Object
- io.leangen.geantyref.GenericTypeReflector

```
public class GenericTypeReflector
extends Object
```
Utility class for doing reflection on types.

Author:

Wouter Coekaerts ([email protected]), Bojan Tomic ([email protected])

Constructor Summary

Constructors
Constructor and Description

GenericTypeReflector()

Constructors
Constructor and Description
`GenericTypeReflector()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Type`	`addWildcardParameters(Class<?> clazz)` Returns a type representing the class, with all type parameters the unbound wildcard ("?").
`static AnnotatedType`	`annotate(Type type)` Recursively wraps a `Type` into an `AnnotatedType` using the annotations found on the erasure classes.
`static AnnotatedType`	`annotate(Type type, Annotation[] annotations)` Recursively wraps a `Type` into an `AnnotatedType` using the annotations found on the erasure classes, plus adding the provided annotations to the top level `Type` only.
`static AnnotatedParameterizedType`	`capture(AnnotatedParameterizedType type)` Applies capture conversion to the given type.
`static AnnotatedType`	`capture(AnnotatedType type)` Applies capture conversion to the given type.
`static AnnotatedType`	`clone(AnnotatedType type)` Creates a new `AnnotatedType` of the same structure and with the same annotations as the provided one.
`static boolean`	`equals(AnnotatedType t1, AnnotatedType t2)` Checks whether the two provided types are of the same structure and annotations on all levels.
`static Class<?>`	`erase(Type type)` Returns the erasure of the given type.
`static AnnotatedType`	`getArrayComponentType(AnnotatedType type)` If type is an array type, returns the type of the component of the array.
`static Type`	`getArrayComponentType(Type type)`
`static AnnotatedType`	`getExactFieldType(Field f, AnnotatedType type)` Returns the exact type of the given field in the given type.
`static Type`	`getExactFieldType(Field f, Type type)`
`static AnnotatedType[]`	`getExactParameterTypes(Method m, AnnotatedType type)` Returns the exact parameter types of the given method in the given type.
`static Type[]`	`getExactParameterTypes(Method m, Type type)`
`static AnnotatedType`	`getExactReturnType(Method m, AnnotatedType type)` Returns the exact return type of the given method in the given type.
`static Type`	`getExactReturnType(Method m, Type type)`
`static AnnotatedType`	`getExactSuperType(AnnotatedType type, Class<?> searchClass)` Finds the most specific supertype of `type` whose erasure is `searchClass`.
`static Type`	`getExactSuperType(Type type, Class<?> searchClass)`
`static Annotation[]`	`getMergedAnnotations(AnnotatedType... types)` Returns an array containing all annotations declared by the given annotated types, without duplicates.
`static String`	`getTypeName(Type type)` Returns the display name of a Type.
`static AnnotatedType`	`getTypeParameter(AnnotatedType type, TypeVariable<? extends Class<?>> variable)` Gets the type parameter for a given type that is the value for a given type variable.
`static Type`	`getTypeParameter(Type type, TypeVariable<? extends Class<?>> variable)`
`static List<Class<?>>`	`getUpperBoundClassAndInterfaces(Type type)` Returns list of classes and interfaces that are supertypes of the given type.
`static boolean`	`isMissingTypeParameters(Type type)` Checks if the given type is a class that is supposed to have type parameters, but doesn't.
`static boolean`	`isSuperType(Type superType, Type subType)` Checks if the capture of subType is a subtype of superType
`static AnnotatedType`	`mapTypeParameters(AnnotatedType toMapType, AnnotatedType typeAndParams)` Maps type parameters in a type to their values.
`static Annotation[]`	`merge(Annotation[]... annotations)` Merges an arbitrary number of annotations arrays, and removes duplicates.
`static AnnotatedType`	`replaceAnnotations(AnnotatedType original, Annotation[] annotations)` Creates a new `AnnotatedType` of the same type as the original, but with its annotations replaced with the provided ones.
`static boolean`	`typeArraysEqual(AnnotatedType[] t1, AnnotatedType[] t2)`
`static AnnotatedType`	`updateAnnotations(AnnotatedType original, Annotation[] annotations)` Creates a new `AnnotatedType` of the same structure as the original, but with its annotations replaced with the provided ones.

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

- Constructor Detail
  - GenericTypeReflector
```
public GenericTypeReflector()
```
- Method Detail
  - erase
```
public static Class<?> erase(Type type)
```
    Returns the erasure of the given type.
  - mapTypeParameters
```
public static AnnotatedType mapTypeParameters(AnnotatedType toMapType,
                                              AnnotatedType typeAndParams)
```
    Maps type parameters in a type to their values.
    
    Parameters:
    
    toMapType - Type possibly containing type arguments
    
    typeAndParams - must be either ParameterizedType, or (in case there are no type arguments, or it's a raw type) Class
    
    Returns:
    
    toMapType, but with type parameters from typeAndParams replaced.
  - isMissingTypeParameters
```
public static boolean isMissingTypeParameters(Type type)
```
    Checks if the given type is a class that is supposed to have type parameters, but doesn't. In other words, if it's a really raw type.
  - addWildcardParameters
```
public static Type addWildcardParameters(Class<?> clazz)
```
    Returns a type representing the class, with all type parameters the unbound wildcard ("?"). For example, addWildcardParameters(Map.class) returns a type representing Map<?,?>.
    Returns:
    If clazz is a class or interface without type parameters, clazz itself is returned.
    
    If clazz is a class or interface with type parameters, an instance of ParameterizedType is returned.
    
    if clazz is an array type, an array type is returned with unbound wildcard parameters added in the the component type.
  - getExactSuperType
```
public static AnnotatedType getExactSuperType(AnnotatedType type,
                                              Class<?> searchClass)
```
    Finds the most specific supertype of type whose erasure is searchClass. In other words, returns a type representing the class searchClass plus its exact type parameters in type.
    - Returns an instance of ParameterizedType if searchClass is a real class or interface and type has parameters for it
    - Returns an instance of GenericArrayType if searchClass is an array type, and type has type parameters for it
    - Returns an instance of Class if type is a raw type, or has no type parameters for searchClass
    - Returns null if searchClass is not a superclass of type.
    For example, with class StringList implements List<String>, getExactSuperType(StringList.class, Collection.class) returns a ParameterizedType representing Collection<String>.
  - getExactSuperType
```
public static Type getExactSuperType(Type type,
                                     Class<?> searchClass)
```
  - getTypeParameter
```
public static AnnotatedType getTypeParameter(AnnotatedType type,
                                             TypeVariable<? extends Class<?>> variable)
```
    Gets the type parameter for a given type that is the value for a given type variable. For example, with class StringList implements List<String>, getTypeParameter(StringList.class, Collection.class.getTypeParameters()[0]) returns String.
    
    Parameters:
    
    type - The type to inspect.
    
    variable - The type variable to find the value for.
    
    Returns:
    
    The type parameter for the given variable. Or null if type is not a subtype of the type that declares the variable, or if the variable isn't known (because of raw types).
  - getTypeParameter
```
public static Type getTypeParameter(Type type,
                                    TypeVariable<? extends Class<?>> variable)
```
  - isSuperType
```
public static boolean isSuperType(Type superType,
                                  Type subType)
```
    Checks if the capture of subType is a subtype of superType
  - getArrayComponentType
```
public static AnnotatedType getArrayComponentType(AnnotatedType type)
```
    If type is an array type, returns the type of the component of the array. Otherwise, returns null.
  - getArrayComponentType
```
public static Type getArrayComponentType(Type type)
```
  - getExactReturnType
```
public static AnnotatedType getExactReturnType(Method m,
                                               AnnotatedType type)
```
    Returns the exact return type of the given method in the given type. This may be different from m.getGenericReturnType() when the method was declared in a superclass, or type has a type parameter that is used in the return type, or type is a raw type.
  - getExactReturnType
```
public static Type getExactReturnType(Method m,
                                      Type type)
```
  - getExactFieldType
```
public static AnnotatedType getExactFieldType(Field f,
                                              AnnotatedType type)
```
    Returns the exact type of the given field in the given type. This may be different from f.getGenericType() when the field was declared in a superclass, or type has a type parameter that is used in the type of the field, or type is a raw type.
  - getExactFieldType
```
public static Type getExactFieldType(Field f,
                                     Type type)
```
  - getExactParameterTypes
```
public static AnnotatedType[] getExactParameterTypes(Method m,
                                                     AnnotatedType type)
```
    Returns the exact parameter types of the given method in the given type. This may be different from m.getGenericParameterTypes() when the method was declared in a superclass, or type has a type parameter that is used in one of the parameters, or type is a raw type.
  - getExactParameterTypes
```
public static Type[] getExactParameterTypes(Method m,
                                            Type type)
```
  - capture
```
public static AnnotatedType capture(AnnotatedType type)
```
    Applies capture conversion to the given type.
  - capture
```
public static AnnotatedParameterizedType capture(AnnotatedParameterizedType type)
```
    Applies capture conversion to the given type.
    
    See Also:
    
    capture(AnnotatedType)
  - getTypeName
```
public static String getTypeName(Type type)
```
    Returns the display name of a Type.
  - getUpperBoundClassAndInterfaces
```
public static List<Class<?>> getUpperBoundClassAndInterfaces(Type type)
```
    Returns list of classes and interfaces that are supertypes of the given type. For example given this class: class Foo<A extends Number & Iterable<A>, B extends A>
    calling this method on type parameters B (Foo.class.getTypeParameters()[1]) returns a list containing Number and Iterable.
    This is mostly useful if you get a type from one of the other methods in GenericTypeReflector, but you don't want to deal with all the different sorts of types, and you are only really interested in concrete classes and interfaces.
    
    Returns:
    
    A List of classes, each of them a supertype of the given type. If the given type is a class or interface itself, returns a List with just the given type. The list contains no duplicates, and is ordered in the order the upper bounds are defined on the type.
  - annotate
```
public static AnnotatedType annotate(Type type)
```
    Recursively wraps a Type into an AnnotatedType using the annotations found on the erasure classes.
    
    Parameters:
    
    type - Type to annotate
    
    Returns:
    
    Type whose structure has been recursively annotated
  - annotate
```
public static AnnotatedType annotate(Type type,
                                     Annotation[] annotations)
```
    Recursively wraps a Type into an AnnotatedType using the annotations found on the erasure classes, plus adding the provided annotations to the top level Type only.
    
    Parameters:
    
    type - Type to annotate
    
    Returns:
    
    Type whose structure has been recursively annotated, plus the provided annotation added at the top level
    See annotate(Type)
  - replaceAnnotations
```
public static AnnotatedType replaceAnnotations(AnnotatedType original,
                                               Annotation[] annotations)
```
    Creates a new AnnotatedType of the same type as the original, but with its annotations replaced with the provided ones.
    
    Parameters:
    
    original - The type whose structure is to be copied
    
    annotations - Annotations to use instead of the ones found on the original
    
    Returns:
    
    A type of the same structure as the original but with replaced annotations
  - updateAnnotations
```
public static AnnotatedType updateAnnotations(AnnotatedType original,
                                              Annotation[] annotations)
```
    Creates a new AnnotatedType of the same structure as the original, but with its annotations replaced with the provided ones.
    
    Parameters:
    
    original - The type whose structure is to be copied
    
    annotations - Annotations to use instead of the ones found on the original
    
    Returns:
    
    A type of the same structure as the original but with replaced annotations
  - clone
```
public static AnnotatedType clone(AnnotatedType type)
```
    Creates a new AnnotatedType of the same structure and with the same annotations as the provided one.
    
    Parameters:
    
    type - The type from which the structure and annotations are to be copied
    
    Returns:
    
    A type of the same structure and with the same annotation as the provided one
  - getMergedAnnotations
```
public static Annotation[] getMergedAnnotations(AnnotatedType... types)
```
    Returns an array containing all annotations declared by the given annotated types, without duplicates.
    
    Parameters:
    
    types - Annotated types whose annotations are to be extracted and merged
    
    Returns:
    
    An array containing all annotations declared by the given annotated types, without duplicates
  - merge
```
public static Annotation[] merge(Annotation[]... annotations)
```
    Merges an arbitrary number of annotations arrays, and removes duplicates.
    
    Parameters:
    
    annotations - Annotation arrays to merge and deduplicate
    
    Returns:
    
    An array containing all annotations from the given arrays, without duplicates
  - typeArraysEqual
```
public static boolean typeArraysEqual(AnnotatedType[] t1,
                                      AnnotatedType[] t2)
```
  - equals
```
public static boolean equals(AnnotatedType t1,
                             AnnotatedType t2)
```
    Checks whether the two provided types are of the same structure and annotations on all levels.
    
    Parameters:
    
    t1 - The first type to be compared
    
    t2 - The second type to be compared
    
    Returns:
    
    True if both types have the same structure and annotations on all levels

Class GenericTypeReflector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GenericTypeReflector

Method Detail

erase

mapTypeParameters

isMissingTypeParameters

addWildcardParameters

getExactSuperType

getExactSuperType

getTypeParameter

getTypeParameter

isSuperType

getArrayComponentType

getArrayComponentType

getExactReturnType

getExactReturnType

getExactFieldType

getExactFieldType

getExactParameterTypes

getExactParameterTypes

capture

capture

getTypeName

getUpperBoundClassAndInterfaces

annotate

annotate

replaceAnnotations

updateAnnotations

clone

getMergedAnnotations

merge

typeArraysEqual

equals