com.google.api.server.spi.config.model

Class Serializers

java.lang.Object

com.google.api.server.spi.config.model.Serializers

public final class Serializers
extends java.lang.Object

Common utility functions for Transformers.

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.Class<? extends Transformer<?,?>>>	getSerializerClasses(java.lang.reflect.Type type, ApiSerializationConfig config) Gets the Transformer class for a particular data type.
static java.util.List<java.lang.Class<? extends Transformer<?,?>>>	getSerializerClasses(com.google.common.reflect.TypeToken<?> type, ApiSerializationConfig config)
static com.google.common.reflect.TypeToken<?>	getSourceType(java.lang.Class<? extends Transformer<?,?>> clazz) Gets the Serializer source type for a class.
static com.google.common.reflect.TypeToken<?>	getTargetType(java.lang.Class<? extends Transformer<?,?>> clazz) Gets the Serializer target type for a class.
static <S extends Transformer<?,?>> S	instantiate(java.lang.Class<S> serializerClass, com.google.common.reflect.TypeToken<?> sourceType) Instantiates a new serializer instance.

Methods inherited from class java.lang.Object

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

Method Detail

instantiate

public static <S extends Transformer<?,?>> S instantiate(java.lang.Class<S> serializerClass,
                                                         com.google.common.reflect.TypeToken<?> sourceType)

Instantiates a new serializer instance.

Parameters:

serializerClass - a serializer class

sourceType - the type being serialized

Returns:

an instance of the serializer

Throws:

java.lang.IllegalStateException - if instantiation failed, or the class does not implement Serializer

getSerializerClasses

public static java.util.List<java.lang.Class<? extends Transformer<?,?>>> getSerializerClasses(@Nullable
                                                                                               java.lang.reflect.Type type,
                                                                                               @Nullable
                                                                                               ApiSerializationConfig config)

Gets the Transformer class for a particular data type. This first checks to see if the type or any of its parents is annotated with ApiTransformer. If that fails, a lookup is made in the serialization config.

Parameters:

type - a type to find a serializer for

config - a serialization config

Returns:

All matching serializers. Could be > 1 if multiple interfaces provide serializers.

getSerializerClasses

public static java.util.List<java.lang.Class<? extends Transformer<?,?>>> getSerializerClasses(com.google.common.reflect.TypeToken<?> type,
                                                                                               @Nullable
                                                                                               ApiSerializationConfig config)

getSourceType

@Nullable
public static com.google.common.reflect.TypeToken<?> getSourceType(java.lang.Class<? extends Transformer<?,?>> clazz)

Gets the Serializer source type for a class. This resolves placeholders in generics.

Parameters:

clazz - a class, possibly implementing Transformer

Returns:

the resolved source type, null if clazz is not a serializer

getTargetType

@Nullable
public static com.google.common.reflect.TypeToken<?> getTargetType(java.lang.Class<? extends Transformer<?,?>> clazz)

Gets the Serializer target type for a class. This resolves placeholders in generics.

Parameters:

clazz - a class, possibly implementing Transformer

Returns:

the resolved target type, null if clazz is not a serializer