uk.co.strangeskies.reflection

Class ParameterizedTypes

java.lang.Object

uk.co.strangeskies.reflection.ParameterizedTypes

public class ParameterizedTypes
extends java.lang.Object

A collection of utility methods relating to parameterized types.

Method Summary

Modifier and Type	Method and Description
static java.util.stream.Stream<java.util.Map.Entry<java.lang.reflect.TypeVariable<?>,java.lang.reflect.Type>>	getAllTypeArguments(java.lang.reflect.ParameterizedType type) For a given parameterized type, we retrieve a mapping of all type variables on its raw type, as given by getAllTypeParameters(Class), to their arguments within the context of this type.
static java.util.stream.Stream<java.lang.reflect.TypeVariable<?>>	getAllTypeParameters(java.lang.Class<?> rawType) This method retrieves a list of all type variables present on the given raw type, as well as all type variables on any enclosing types recursively, in the order encountered.
static java.lang.reflect.ParameterizedType	parameterize(java.lang.Class<?> rawType) Derive an instance of ParameterizedType from a raw Class, substituting the type parameters of that class as their own argument instantiations.
static java.lang.reflect.ParameterizedType	parameterize(java.lang.Class<?> rawType, java.util.function.Function<? super java.lang.reflect.TypeVariable<?>,? extends java.lang.reflect.Type> typeArguments) Derive an instance of ParameterizedType from a raw Class using the given generic type arguments.
static java.lang.reflect.ParameterizedType	parameterize(java.lang.Class<?> rawType, java.util.List<java.lang.reflect.Type> typeArguments) Derive an instance of ParameterizedType from a raw Class using the given generic type arguments, in the order given.
static java.lang.reflect.ParameterizedType	parameterize(java.lang.Class<?> rawType, java.lang.reflect.Type... typeArguments) Derive an instance of ParameterizedType from a raw Class using the given generic type arguments, in the order given.
static java.lang.reflect.ParameterizedType	parameterizeUnchecked(java.lang.Class<?> rawType, java.util.List<java.lang.reflect.Type> typeArguments) As @see parameterize(Class, List), but without checking type arguments for consistency.
static java.lang.reflect.ParameterizedType	parameterizeUnchecked(java.lang.Class<?> rawType, java.lang.reflect.Type... typeArguments) As @see parameterize(Class, Type[]), but without checking type arguments for consistency.
static <T> java.lang.reflect.ParameterizedType	parameterizeUnchecked(java.lang.Class<T> rawType, java.util.function.Function<? super java.lang.reflect.TypeVariable<?>,? extends java.lang.reflect.Type> typeArguments) As @see parameterize(Class, Function), but without checking type arguments for consistency.
static java.lang.reflect.ParameterizedType	parameterizeUnchecked(java.lang.reflect.Type ownerType, java.lang.Class<?> rawType, java.util.List<java.lang.reflect.Type> typeArguments) Derive an instance of ParameterizedType from a raw Class using the given generic type arguments and owning type.
static java.lang.String	toString(java.lang.reflect.ParameterizedType parameterizedType, Imports imports) Format a string describing a given parameterized type, assuming the given imports.
static java.lang.String	toString(java.lang.reflect.ParameterizedType parameterizedType, Imports imports, Isomorphism isomorphism) Format a string describing a given parameterized type, assuming the given imports and using the given Isomorphism to skip recurring types.
protected static java.lang.reflect.ParameterizedType	validate(java.lang.reflect.ParameterizedType type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

toString

public static java.lang.String toString(java.lang.reflect.ParameterizedType parameterizedType,
                                        Imports imports)

Format a string describing a given parameterized type, assuming the given imports.

Parameters:

parameterizedType - the type we wish to express as a string

imports - the imports with which to inform qualification omission

Returns:

a string representation of the given parameterized type

toString

public static java.lang.String toString(java.lang.reflect.ParameterizedType parameterizedType,
                                        Imports imports,
                                        Isomorphism isomorphism)

Format a string describing a given parameterized type, assuming the given imports and using the given Isomorphism to skip recurring types.

Parameters:

parameterizedType - the type we wish to express as a string

imports - the imports with which to inform qualification omission

isomorphism - the isomorphism with which to skip repeated types

Returns:

a string representation of the given parameterized type

getAllTypeParameters

public static java.util.stream.Stream<java.lang.reflect.TypeVariable<?>> getAllTypeParameters(java.lang.Class<?> rawType)

This method retrieves a list of all type variables present on the given raw type, as well as all type variables on any enclosing types recursively, in the order encountered.

Parameters:

rawType - The class whose generic type parameters we wish to determine.

Returns:

A list of all relevant type variables.

getAllTypeArguments

public static java.util.stream.Stream<java.util.Map.Entry<java.lang.reflect.TypeVariable<?>,java.lang.reflect.Type>> getAllTypeArguments(java.lang.reflect.ParameterizedType type)

For a given parameterized type, we retrieve a mapping of all type variables on its raw type, as given by getAllTypeParameters(Class), to their arguments within the context of this type.

Parameters:

type - The type whose generic type arguments we wish to determine.

Returns:

A mapping of all type variables to their arguments in the context of the given type.

parameterizeUnchecked

public static java.lang.reflect.ParameterizedType parameterizeUnchecked(java.lang.reflect.Type ownerType,
                                                                        java.lang.Class<?> rawType,
                                                                        java.util.List<java.lang.reflect.Type> typeArguments)

Derive an instance of ParameterizedType from a raw Class using the given generic type arguments and owning type. Type parameters with no provided argument will be parameterized with the type variables themselves.

Parameters:

ownerType - the owner type for the resulting parameterized type

rawType - A raw Class from which we wish to determine a ParameterizedType.

typeArguments - A mapping of generic type variables to arguments.

Returns:

A ParameterizedType instance over the given class, parameterized with the given type arguments.

parameterizeUnchecked

public static java.lang.reflect.ParameterizedType parameterizeUnchecked(java.lang.Class<?> rawType,
                                                                        java.lang.reflect.Type... typeArguments)

As @see parameterize(Class, Type[]), but without checking type arguments for consistency.

parameterizeUnchecked

public static java.lang.reflect.ParameterizedType parameterizeUnchecked(java.lang.Class<?> rawType,
                                                                        java.util.List<java.lang.reflect.Type> typeArguments)

As @see parameterize(Class, List), but without checking type arguments for consistency.

parameterizeUnchecked

public static <T> java.lang.reflect.ParameterizedType parameterizeUnchecked(java.lang.Class<T> rawType,
                                                                            java.util.function.Function<? super java.lang.reflect.TypeVariable<?>,? extends java.lang.reflect.Type> typeArguments)

As @see parameterize(Class, Function), but without checking type arguments for consistency.

parameterize

public static java.lang.reflect.ParameterizedType parameterize(java.lang.Class<?> rawType)

Derive an instance of ParameterizedType from a raw Class, substituting the type parameters of that class as their own argument instantiations.

Parameters:

rawType - A raw Class from which we wish to determine a ParameterizedType.

Returns:

A ParameterizedType instance over the given class.

parameterize

public static java.lang.reflect.ParameterizedType parameterize(java.lang.Class<?> rawType,
                                                               java.util.function.Function<? super java.lang.reflect.TypeVariable<?>,? extends java.lang.reflect.Type> typeArguments)

Derive an instance of ParameterizedType from a raw Class using the given generic type arguments. Type parameters with no provided argument will be parameterized with the type variables themselves.

Parameters:

rawType - A raw Class from which we wish to determine a ParameterizedType.

typeArguments - A mapping of generic type variables to arguments.

Returns:

A ParameterizedType instance over the given class, parameterized with the given type arguments.

parameterize

public static java.lang.reflect.ParameterizedType parameterize(java.lang.Class<?> rawType,
                                                               java.lang.reflect.Type... typeArguments)

Derive an instance of ParameterizedType from a raw Class using the given generic type arguments, in the order given.

Parameters:

rawType - A raw Class from which we wish to determine a ParameterizedType. The raw type must not have a non statically enclosing type which is itself generic.

typeArguments - A list of Types to substitute as type arguments for the given generic class. There should be exactly as many type arguments as there are type parameters for the given class.

Returns:

A ParameterizedType instance over the given class, parameterized with the given type arguments, in order

parameterize

public static java.lang.reflect.ParameterizedType parameterize(java.lang.Class<?> rawType,
                                                               java.util.List<java.lang.reflect.Type> typeArguments)

Derive an instance of ParameterizedType from a raw Class using the given generic type arguments, in the order given.

Parameters:

rawType - A raw Class from which we wish to determine a ParameterizedType. The raw type must not have a non statically enclosing type which is itself generic.

typeArguments - A list of Types to substitute as type arguments for the given generic class. There should be exactly as many type arguments as there are type parameters for the given class.

Returns:

A ParameterizedType instance over the given class, parameterized with the given type arguments, in order

validate

protected static java.lang.reflect.ParameterizedType validate(java.lang.reflect.ParameterizedType type)