ca.jeb.protobuf

Annotation Type ProtobufAttribute

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface ProtobufAttribute

ProtobufAttribute annotation for defining your POJO attributes for serialization to and from Protobuf classes/entities.

Author:

Erick Bourgeois

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends IProtobufConverter>	converter This should be set to a class that implements the IProtoBufConverter.
String	pojoGetter This attribute defines what the getter method name should be to retrieve the data from the POJO object.
String	pojoSetter This attribute defines what the target setter method should be used on the POJO object.
String	protobufGetter This attribute defines what the getter method name should be to retrieve the data from the ProtobufEntity object.
String	protobufSetter This attribute defines what the target method should be used on the ProtobufEntity.
boolean	required This attribute should be used to indicate that this interface should consider this field to be required with ProtoBuf class.

Element Detail

required

public abstract boolean required

This attribute should be used to indicate that this interface should consider this field to be required with ProtoBuf class.

Returns:

boolean

Default:

false

protobufSetter

public abstract String protobufSetter

This attribute defines what the target method should be used on the ProtobufEntity. This will default to "set" + upperCaseFirst(fieldName).

Returns:

String

Default:

""

protobufGetter

public abstract String protobufGetter

This attribute defines what the getter method name should be to retrieve the data from the ProtobufEntity object. This defaults to "get" + upperCaseFirst(fieldName).

Returns:

String

Default:

""

pojoGetter

public abstract String pojoGetter

This attribute defines what the getter method name should be to retrieve the data from the POJO object. This defaults to "get" + upperCaseFirst(fieldName).

Returns:

String

Default:

""

pojoSetter

public abstract String pojoSetter

This attribute defines what the target setter method should be used on the POJO object. This will default to "set" + upperCaseFirst(fieldName).

Returns:

String

Default:

""

converter

public abstract Class<? extends IProtobufConverter> converter

This should be set to a class that implements the IProtoBufConverter. This converter will be used to convert the value from the POJO objects to the Google ProtoBuf object; default is NullConverter.

Returns:

Class<? extends IProtobufConverter>

Default:

ca.jeb.protobuf.converter.NullConverter.class