Package me.datafox.dfxengine.injector.api

Class TypeRef<T>

java.lang.Object

me.datafox.dfxengine.injector.api.TypeRef<T>

public final class TypeRef<T>
extends Object

Represents a type with parameters. This class is used when requesting Components from the Injector. As an example, if you wanted to reference Component<Type1,Type2<Type3>>, you would call TypeRef.of(Component.class, TypeRef.of(Type1.class), TypeRef.of(Type2.class, TypeRef.of(Type3.class)));. The constructor checks for parameter count and throws an exception if an invalid amount of type parameters.

Constructor Summary

Constructors

Constructor	Description
TypeRef(Class<T> type, boolean sup, List<TypeRef<?>> parameters)	Constructs a type reference

Method Summary

Modifier and Type	Method	Description
static TypeRef<Object>	object()
static <T> TypeRef<T>	of(Class<T> type, boolean sup, Class<?> firstParameter, Class<?>... parameters)
static <T> TypeRef<T>	of(Class<T> type, boolean sup, List<TypeRef<?>> parameters)
static <T> TypeRef<T>	of(Class<T> type, boolean sup, TypeRef<?>... parameters)
static <T> TypeRef<T>	of(Class<T> type, Class<?> firstParameter, Class<?>... parameters)
static <T> TypeRef<T>	of(Class<T> type, List<TypeRef<?>> parameters)
static <T> TypeRef<T>	of(Class<T> type, TypeRef<?>... parameters)
String	toString()
String	toStringParametersWithoutPackage()
String	toStringWithoutPackage()
TypeRef<?>	uncast()	The purpose of this method is to be able to cast a type reference to a parameterised type with multiple type layers without the compiler complaining about illegal casting.

Methods inherited from class java.lang.Object

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

Constructor Details

TypeRef

public TypeRef(Class<T> type,
 boolean sup,
 List<TypeRef<?>> parameters)

Constructs a type reference

Parameters:

type - type to be represented

sup - true if this type reference refers to ? super T

parameters - type parameters to be represented

Throws:

ParameterCountMismatchException - if the amount of parameters for the specified type is different to the amount of provided parameters

Method Details

uncast

public TypeRef<?> uncast()

The purpose of this method is to be able to cast a type reference to a parameterised type with multiple type layers without the compiler complaining about illegal casting. For example, calling TypeRef.of(Map.class, String.class, Integer.class) will return an object with type TypeRef<Map> without the parameters for Map, and casting that directly to TypeRef<Map<String,Integer>> is not allowed. But casting from TypeRef<?> is allowed, so calling (TypeRef<Map<String,Integer>>) TypeRef.of(Map.class, String.class, Integer.class).uncast() will work. This is mainly useful for getting the component with the right runtime type with Injector.getComponent(TypeRef) and related methods.

Returns:

this type reference as TypeRef<?>

toStringWithoutPackage

public String toStringWithoutPackage()

Returns:

String representation of this type reference in the format "Type<Parameter,Other<Child>>" without packages

toStringParametersWithoutPackage

public String toStringParametersWithoutPackage()

Returns:

String representation of this type reference in the format "Type<Parameter,Other<Child>>" with the parameters without packages

toString

public String toString()

Overrides:

toString in class Object

Returns:

String representation of this type reference in the format "Type<Parameter,Other<Child>>"

object

public static TypeRef<Object> object()

Returns:

type reference for Object

of

public static <T> TypeRef<T> of(Class<T> type,
 List<TypeRef<?>> parameters)

Type Parameters:

T - type for the type reference

Parameters:

type - type for the type reference

parameters - parameters for the type reference

Returns:

type reference for the specified parameters

of

public static <T> TypeRef<T> of(Class<T> type,
 boolean sup,
 List<TypeRef<?>> parameters)

Type Parameters:

T - type for the type reference

Parameters:

type - type for the type reference

sup - true if the type reference refers to ? super T

parameters - parameters for the type reference

Returns:

type reference for the specified parameters

of

public static <T> TypeRef<T> of(Class<T> type,
 TypeRef<?>... parameters)

Type Parameters:

T - type for the type reference

Parameters:

type - type for the type reference

parameters - parameters for the type reference

Returns:

type reference for the specified parameters

of

public static <T> TypeRef<T> of(Class<T> type,
 boolean sup,
 TypeRef<?>... parameters)

Type Parameters:

T - type for the type reference

Parameters:

type - type for the type reference

sup - true if the type reference refers to ? super T

parameters - parameters for the type reference

Returns:

type reference for the specified parameters

of

public static <T> TypeRef<T> of(Class<T> type,
 Class<?> firstParameter,
 Class<?>... parameters)

Type Parameters:

T - type for the type reference

Parameters:

type - type for the type reference

firstParameter - first parameter for the type reference

parameters - other parameters for the type reference

Returns:

type reference for the specified parameters

of

public static <T> TypeRef<T> of(Class<T> type,
 boolean sup,
 Class<?> firstParameter,
 Class<?>... parameters)

Type Parameters:

T - type for the type reference

Parameters:

type - type for the type reference

sup - true if the type reference refers to ? super T

firstParameter - first parameter for the type reference

parameters - other parameters for the type reference

Returns:

type reference for the specified parameters