TypeInfo (JavaTypeResolver 0.1.0 API)

java.lang.Object
- ch.jalu.typeresolver.TypeInfo

Direct Known Subclasses:

NestedTypeReference, TypeReference
```
public class TypeInfo
extends Object
```
Wraps a Type to offer easy retrieval of various type information.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TypeInfo()` No-args constructor for overriding classes which define the type to wrap by overriding `inferTypeForNoArgsConstructor()`.
	`TypeInfo(Type type)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`boolean`	`equalTo(Class<?> clazz)` Returns whether this type info, as class (`toClass()`), is equal to the given class.
`Set<TypeInfo>`	`getAllTypeInfos()` Returns all types that this wrapped type is an instance of, as TypeInfo instances.
`Set<Type>`	`getAllTypes()` Returns all types that this wrapped type is an instance of, i.e.
`@Nullable TypeInfo`	`getComponentType()` Returns the array component type of this type, if applicable.
`@Nullable TypeInfo`	`getEnclosingType()` Returns a type info of the enclosing type (i.e.
`Class<?>`	`getSafeToReadClass()` Returns a `Class` object of the wrapped type which is safe for reading.
`Type`	`getType()`
`@Nullable Class<?>`	`getTypeArgumentAsClass(int index)` Returns the type argument for the given index as Class object, provided that the type is a parameterized type and that the index is valid.
`@Nullable TypeInfo`	`getTypeArgumentInfo(int index)` Returns the type argument at the given index for the wrapped type, provided that the type is a parameterized type and that the index is valid.
`int`	`hashCode()`
`protected Type`	`inferTypeForNoArgsConstructor()` Called in the no-args constructor, allowing to infer the type through some other way.
`boolean`	`isAssignableFrom(Class<?> clazz)` Returns whether the class represented by this type info is equal or assignable from the given class.
`static TypeInfo`	`of(Field field)` Creates a new instance wrapping the generic type of the given field.
`static TypeInfo`	`of(Type type)` Creates a new instance wrapping the given type.
`TypeInfo`	`resolve(Type type)` Resolves the given type if possible, based on information from the wrapped Type of this instance.
`@Nullable TypeInfo`	`resolveSuperclass(Class<?> clazz)` Returns the given class' including its type arguments if it is a superclass of this wrapped type.
`@Nullable Class<?>`	`toClass()` Returns a `Class` object of the wrapped type which is safe for writing to.
`String`	`toString()`
`void`	`visitAllTypes(Consumer<Type> typeVisitor)` Invokes the given consumer for each type that this wrapped type can be assigned to (i.e.

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

- Constructor Detail
  - TypeInfo
```
public TypeInfo(Type type)
```
    Constructor. Alternatively, use of(Type) or of(Field).
    
    Parameters:
    
    type - the type to wrap (e.g. coming from Field.getGenericType())
  - TypeInfo
```
protected TypeInfo()
```
    No-args constructor for overriding classes which define the type to wrap by overriding inferTypeForNoArgsConstructor().
    
    See Also:
    
    TypeReference
- Method Detail
  - of
```
public static TypeInfo of(Type type)
```
    Creates a new instance wrapping the given type.
    
    Parameters:
    
    type - the type to wrap
    
    Returns:
    
    type info for the given type
  - of
```
public static TypeInfo of(Field field)
```
    Creates a new instance wrapping the generic type of the given field.
    
    Parameters:
    
    field - the field whose generic type should be used
    
    Returns:
    
    type info for the field's type
  - getType
```
public Type getType()
```
    Returns:
    
    the type wrapped by this instance
  - getTypeArgumentInfo
```
@Nullable
public @Nullable TypeInfo getTypeArgumentInfo(int index)
```
    Returns the type argument at the given index for the wrapped type, provided that the type is a parameterized type and that the index is valid. Returns null if not applicable.
    Examples for index = 0:
    - type = String -> result = null
    - type = List<String> -> result = String.class
    - type = Map<List<Integer>, String> -> result = List<Integer>
    - type = List -> result = null
    Parameters:
    
    index - the index of the type parameter to get (0-based)
    
    Returns:
    
    the type argument for the given index, null if not applicable
  - getTypeArgumentAsClass
```
@Nullable
public @Nullable Class<?> getTypeArgumentAsClass(int index)
```
    Returns the type argument for the given index as Class object, provided that the type is a parameterized type and that the index is valid. Returns null if not applicable, or if the generic type info cannot be converted to a safe-to-write Class.
    Examples for index = 0:
    - type = String -> result = null
    - type = List<String> -> result = String.class
    - type = Map<List<Integer>, String> -> result = List.class
    - type = List<T> -> result = null
    - type = List -> result = null
    Parameters:
    
    index - the index of the type parameter to get (0-based)
    
    Returns:
    
    the type argument as safe-to-write class, null if not applicable
  - toClass
```
@Nullable
public @Nullable Class<?> toClass()
```
    Returns a Class object of the wrapped type which is safe for writing to. In other words, if this instance wraps the Type of a field, an object of the same Class as returned by this method can be set to the field.
    Examples:
    - type = String -> result = String.class
    - type = List<String> -> result = List.class
    - type = ? super Integer -> result = Integer.class
    - type = ? extends Comparable -> result = null
    Returns:
    
    the type as a Class which is safe to use for writing (e.g. setting a value to a field or adding to a collection); null if not applicable
  - getSafeToReadClass
```
public Class<?> getSafeToReadClass()
```
    Returns a Class object of the wrapped type which is safe for reading. For example, if this instance wraps the Type of a field, then the value on the field is guaranteed to be of the Class type returned by this method (unless the value is null). The returned Class is as specific as possible.
    Examples:
    - type = String -> result = String.class
    - type = List<String> -> result = List.class
    - type = ? super Integer -> result = Object.class
    - type = ? extends Comparable -> result = Comparable.class
    Returns:
    
    the type as Class which is safe for reading (e.g. getting field value or reading from a collection)
  - equalTo
```
public boolean equalTo(Class<?> clazz)
```
    Returns whether this type info, as class (toClass()), is equal to the given class.
    Examples:
    - new TypeInfo(String.class).equalTo(String.class) // true
    - new TypeReference<List<String>>() { }.equalTo(List.class) // true
    - new TypeReference<List<String>>() { }.equalTo(ArrayList.class) // false
    Parameters:
    
    clazz - the class to check for equality
    
    Returns:
    
    true if this type info converts to the same class as the given one, false otherwise
  - isAssignableFrom
```
public boolean isAssignableFrom(Class<?> clazz)
```
    Returns whether the class represented by this type info is equal or assignable from the given class. In other words, this TypeInfo's toClass() checks with Class.isAssignableFrom(java.lang.Class<?>) whether the given class is equal or an extension of this type info's class.
    Examples:
    - new TypeInfo(String.class).isAssignableFrom(Double.class) // false
    - new TypeReference<List<String>>() { }.isAssignableFrom(List.class) // true
    - new TypeReference<List<String>>() { }.isAssignableFrom(ArrayList.class) // true
    Parameters:
    
    clazz - the class to check with
    
    Returns:
    
    true if this type info's class is equal or a supertype of the given class, false otherwise
  - getEnclosingType
```
@Nullable
public @Nullable TypeInfo getEnclosingType()
```
    Returns a type info of the enclosing type (i.e. the outer class if this type is a nested class). Returns null if not applicable.
    
    Returns:
    
    the enclosing type, or null if this type is not a nested type
  - getComponentType
```
@Nullable
public @Nullable TypeInfo getComponentType()
```
    Returns the array component type of this type, if applicable. Returns null otherwise (if the type doesn't represent an array).
    
    Returns:
    
    the component type of this array type, or null if this type is not an array
  - resolve
```
public TypeInfo resolve(Type type)
```
    Resolves the given type if possible, based on information from the wrapped Type of this instance. For example, if this type info's type is Optional<String> and the input type is the Optional's T type, String will be returned.
    Supported actions:
    - Resolution of type variables, e.g. T to String
    - Resolution of type arguments, e.g. Map<K, V> to Map<String, Long>.
    - Resolution of generic array type, e.g. T[] to List<String>[]
    - Resolution within wildcard bounds, e.g. ? super T to ? super Serializable
    Parameters:
    
    type - the type to resolve
    
    Returns:
    
    the resolved type, or the original type if no resolution was possible, never null
  - resolveSuperclass
```
@Nullable
public @Nullable TypeInfo resolveSuperclass(Class<?> clazz)
```
    Returns the given class' including its type arguments if it is a superclass of this wrapped type. Returns null if the given class is not a superclass of this wrapped type.
    
    Parameters:
    
    clazz - the desired superclass to get the info for
    
    Returns:
    
    the type info of the superclass of the given class, or null if this wrapped type is not a supertype
  - getAllTypes
```
public Set<Type> getAllTypes()
```
    Returns all types that this wrapped type is an instance of, i.e. returns all superclasses and interfaces that the class can be assigned to.
    
    Returns:
    
    all types that this wrapped type can be assigned to
  - getAllTypeInfos
```
public Set<TypeInfo> getAllTypeInfos()
```
    Returns all types that this wrapped type is an instance of, as TypeInfo instances.
    
    Returns:
    
    all types this wrapped type can be assigned to
  - visitAllTypes
```
public void visitAllTypes(Consumer<Type> typeVisitor)
```
    Invokes the given consumer for each type that this wrapped type can be assigned to (i.e. all parents and interfaces).
    
    Parameters:
    
    typeVisitor - callback run for each type that this wrapped type can be assigned to
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - inferTypeForNoArgsConstructor
```
protected Type inferTypeForNoArgsConstructor()
```
    Called in the no-args constructor, allowing to infer the type through some other way.
    
    Returns:
    
    the type this instance will wrap

Class TypeInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TypeInfo

TypeInfo

Method Detail

of

of

getType

getTypeArgumentInfo

getTypeArgumentAsClass

toClass

getSafeToReadClass

equalTo

isAssignableFrom

getEnclosingType

getComponentType

resolve

resolveSuperclass

getAllTypes

getAllTypeInfos

visitAllTypes

equals

hashCode

toString

inferTypeForNoArgsConstructor