com.squareup.moshi

Class Types

java.lang.Object

com.squareup.moshi.Types

@CheckReturnValue
public final class Types
extends Object

Factory methods for types.

Method Summary

Modifier and Type	Method and Description
static GenericArrayType	arrayOf(Type componentType) Returns an array type whose elements are all instances of componentType.
static Type	collectionElementType(Type context, Class<?> contextRawType) Returns the element type of this collection type.
static boolean	equals(Type a, Type b) Returns true if a and b are equal.
static Set<? extends Annotation>	getFieldJsonQualifierAnnotations(Class<?> clazz, String fieldName)
static Class<?>	getRawType(Type type)
static ParameterizedType	newParameterizedType(Type rawType, Type... typeArguments) Returns a new parameterized type, applying typeArguments to rawType.
static ParameterizedType	newParameterizedTypeWithOwner(Type ownerType, Type rawType, Type... typeArguments) Returns a new parameterized type, applying typeArguments to rawType.
static Set<? extends Annotation>	nextAnnotations(Set<? extends Annotation> annotations, Class<? extends Annotation> jsonQualifier) Checks if annotations contains jsonQualifier.
static WildcardType	subtypeOf(Type bound) Returns a type that represents an unknown type that extends bound.
static WildcardType	supertypeOf(Type bound) Returns a type that represents an unknown supertype of bound.

Methods inherited from class java.lang.Object

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

Method Detail

nextAnnotations

@Nullable
public static Set<? extends Annotation> nextAnnotations(Set<? extends Annotation> annotations,
                                                                  Class<? extends Annotation> jsonQualifier)

Checks if annotations contains jsonQualifier. Returns the subset of annotations without jsonQualifier, or null if annotations does not contain jsonQualifier.

newParameterizedType

public static ParameterizedType newParameterizedType(Type rawType,
                                                     Type... typeArguments)

Returns a new parameterized type, applying typeArguments to rawType. Use this method if rawType is not enclosed in another type.

newParameterizedTypeWithOwner

public static ParameterizedType newParameterizedTypeWithOwner(Type ownerType,
                                                              Type rawType,
                                                              Type... typeArguments)

Returns a new parameterized type, applying typeArguments to rawType. Use this method if rawType is enclosed in ownerType.

arrayOf

public static GenericArrayType arrayOf(Type componentType)

Returns an array type whose elements are all instances of componentType.

subtypeOf

public static WildcardType subtypeOf(Type bound)

Returns a type that represents an unknown type that extends bound. For example, if bound is CharSequence.class, this returns ? extends CharSequence. If bound is Object.class, this returns ?, which is shorthand for ? extends Object.

supertypeOf

public static WildcardType supertypeOf(Type bound)

Returns a type that represents an unknown supertype of bound. For example, if bound is String.class, this returns ? super String.

getRawType

public static Class<?> getRawType(Type type)

collectionElementType

public static Type collectionElementType(Type context,
                                         Class<?> contextRawType)

Returns the element type of this collection type.

Throws:

IllegalArgumentException - if this type is not a collection.

equals

public static boolean equals(@Nullable
                             Type a,
                             @Nullable
                             Type b)

Returns true if a and b are equal.

getFieldJsonQualifierAnnotations

public static Set<? extends Annotation> getFieldJsonQualifierAnnotations(Class<?> clazz,
                                                                         String fieldName)

Parameters:

clazz - the target class to read the fieldName field annotations from.

fieldName - the target field name on clazz.

Returns:

a set of JsonQualifier-annotated Annotation instances retrieved from the targeted field. Can be empty if none are found.