TypeReference<T> Class

  • Reference
Package:
com.azure.core.util.serializer
Maven Artifact:
com.azure:azure-core:1.49.0
  • java.lang.Object
    • com.azure.core.util.serializer.TypeReference<T>

Type Parameters

T

The type being represented.

public abstract class TypeReference

This class represents a generic Java type, retaining information about generics.

Code sample

// Construct a TypeReference<T> for a Java generic type.
 // This pattern should only be used for generic types, for classes use the createInstance factory method.
 TypeReference<Map<String, Object>> typeReference = new TypeReference<Map<String, Object>>() { };

// Construct a TypeReference<T> for a Java class.
 // This pattern should only be used for non-generic classes when possible, use the constructor for generic
 // class when possible.
 TypeReference<Integer> typeReference = TypeReference.createInstance(int.class);

Constructor Summary

Constructor Description
TypeReference()

Constructs a new TypeReference<T> which maintains generic information.

Method Summary

Modifier and Type Method and Description
static TypeReference<T> createInstance(Class<T> clazz)

Creates and instance of TypeReference<T> which maintains the generic T of the passed Class.
Class<T> getJavaClass()

Returns the Class representing instance of the TypeReference<T> created.
Type getJavaType()

Returns the Type representing T.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TypeReference

public TypeReference()

Constructs a new TypeReference<T> which maintains generic information.

Method Details

createInstance

public static TypeReference createInstance(Class clazz)

Creates and instance of TypeReference<T> which maintains the generic T of the passed Class.

This method will cache the instance of TypeReference<T> using the passed Class as the key. This is meant to be used with non-generic types such as primitive object types and POJOs, not Map or List parameterized types.

Parameters:

clazz - Class that contains generic information used to create the TypeReference<T>.

Returns:

Either the cached or new instance of TypeReference<T>.

getJavaClass

public Class getJavaClass()

Returns the Class representing instance of the TypeReference<T> created.

Returns:

The Class representing instance of the TypeReference<T> created using the createInstance(Class<T> clazz), otherwise returns null.

getJavaType

public Type getJavaType()

Returns the Type representing T.

Returns:

The Type representing T.

Applies to