ca.jeb.protobuf.internal

Class ProtobufSerializerUtils

java.lang.Object

ca.jeb.protobuf.internal.ProtobufSerializerUtils

public final class ProtobufSerializerUtils
extends Object

Utility class to help out the ProtobufSerializer.

Author:

Erick Bourgeois

Constructor Summary

Constructors

Constructor and Description
ProtobufSerializerUtils()

Method Summary

Modifier and Type	Method and Description
static Map<Field,ProtobufAttribute>	getAllProtbufFields(Class<? extends Object> fromClazz) Returns a full mapping of all Protobuf fields from the POJO class.
static String	getPojoSetter(ProtobufAttribute protobufAttribute, Field field) Retrieve the setter on the POJO class; default is to is "set" plus upper case first character of the field name.
static Class<? extends Object>	getProtobufClass(Object value, Class<? extends Object> protobufClass) Retrieve the ProtobufClass based on the POJO value.
static Class<? extends com.google.protobuf.GeneratedMessage>	getProtobufClassFromPojoAnno(Class<?> clazz) Return the Protobuf Class based on the pojo class, i.e.
static ProtobufEntity	getProtobufEntity(Class<?> clazz) Return a ProtobufEntity annotation from any object sent, null if there is none.
static String	getProtobufGetter(ProtobufAttribute protobufAttribute, Field field) Retrieve the getter against the Protobuf class; default is to is "get" plus upper case first character of the field name.
static String	getProtobufSetter(ProtobufAttribute protobufAttribute, Field field, Object fieldValue) Return the setter for the Protobuf builder.
static boolean	isProtbufEntity(Class<?> clazz) Returns true if there is a ProtobufEntity annotation on this class.
static boolean	isProtbufEntity(Object object) Returns true if there is a ProtobufEntity annotation on this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtobufSerializerUtils

public ProtobufSerializerUtils()

Method Detail

getProtobufClass

public static final Class<? extends Object> getProtobufClass(Object value,
                                                             Class<? extends Object> protobufClass)

Retrieve the ProtobufClass based on the POJO value. The returned value may get converted, as the Protobuf builders/setters use primitives. For example, if user has declared Integer, this get's converted to int.

Parameters:

value - - POJO object

protobufClass - - the Protobuf class

Returns:

Class<? extends Object> - actual Protobuf class to use in setter

getProtobufEntity

public static final ProtobufEntity getProtobufEntity(Class<?> clazz)

Return a ProtobufEntity annotation from any object sent, null if there is none.

Parameters:

clazz - - any Class

Returns:

ProtobufEntity annotation

See Also:

ProtobufEntity

isProtbufEntity

public static final boolean isProtbufEntity(Object object)

Returns true if there is a ProtobufEntity annotation on this object.

Parameters:

object - - a POJO object

Returns:

boolean - true, if there is a ProtobufEntity annotation, else, false

See Also:

ProtobufEntity

isProtbufEntity

public static final boolean isProtbufEntity(Class<?> clazz)

Returns true if there is a ProtobufEntity annotation on this class.

Parameters:

clazz - - any Class

Returns:

boolean - true, if there is a ProtobufEntity annotation, else, false

See Also:

ProtobufEntity

getProtobufClassFromPojoAnno

public static final Class<? extends com.google.protobuf.GeneratedMessage> getProtobufClassFromPojoAnno(Class<?> clazz)

Return the Protobuf Class based on the pojo class, i.e. grab the value from the ProtobufEntity annotation.

Parameters:

clazz - - any Class

Returns:

Class<? extends GeneratedMessage>

getAllProtbufFields

public static final Map<Field,ProtobufAttribute> getAllProtbufFields(Class<? extends Object> fromClazz)

Returns a full mapping of all Protobuf fields from the POJO class. Essentially, the only fields that will be returned if they have the ProtobufAttribute annotation.

Parameters:

fromClazz - - Class<? extends Object>

Returns:

Map<Field, ProtobufAttribute>

getProtobufSetter

public static final String getProtobufSetter(ProtobufAttribute protobufAttribute,
                                             Field field,
                                             Object fieldValue)

Return the setter for the Protobuf builder.
1. Defaults to just "set" + upper case the first character of the fieldName. 2. If it's a collection, use the "addAll" type method Protobuf has 3. Otherwise, use the override value from the user's ProtobufAttribute annotation

Parameters:

protobufAttribute - - ProtobufAttribute

field - - String

fieldValue - - POJO's filed Object

Returns:

String - the setter to be used on Protobuf builder

getProtobufGetter

public static final String getProtobufGetter(ProtobufAttribute protobufAttribute,
                                             Field field)

Retrieve the getter against the Protobuf class; default is to is "get" plus upper case first character of the field name.

Parameters:

protobufAttribute - - ProtobufAttribute

field - - Field

Returns:

String

getPojoSetter

public static final String getPojoSetter(ProtobufAttribute protobufAttribute,
                                         Field field)

Retrieve the setter on the POJO class; default is to is "set" plus upper case first character of the field name.

Parameters:

protobufAttribute - - ProtobufAttribute

field - - Field

Returns:

String - the name of the POJO setter