Class AbstractMarshallerCodeGenerator

java.lang.Object

org.infinispan.protostream.annotations.impl.AbstractMarshallerCodeGenerator

Direct Known Subclasses:

MarshallerSourceCodeGenerator

public abstract class AbstractMarshallerCodeGenerator
extends Object

Since:

4.3

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ADAPTER_FIELD_NAME
private final boolean	noDefaults	Do nullable fields that do not have a user defined default value get a default type specific value if missing instead of just null? This is currently implemented just for arrays/collections.
private final String	protobufSchemaPackage
private static final String	PROTOSTREAM_PACKAGE
private final XTypeFactory	typeFactory
private final boolean	useGenerics

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMarshallerCodeGenerator(XTypeFactory typeFactory, String protobufSchemaPackage)

Method Summary

Modifier and Type	Method	Description
private String	box(String v, XClass clazz)	Boxes a given value.
private XClass	box(XClass clazz)	Return the corresponding 'boxed' Class given a Class, or null if no type change is required.
private String	convert(String v, ProtoFieldMetadata fieldMetadata)	Cast the given value if necessary.
private String	createGetPropExpr(ProtoMessageTypeMetadata messageTypeMetadata, ProtoFieldMetadata fieldMetadata, String obj)
private String	createSetPropExpr(ProtoMessageTypeMetadata messageTypeMetadata, ProtoFieldMetadata fieldMetadata, String obj, String value)
protected String	generateEnumDecodeMethodBody(ProtoEnumTypeMetadata enumTypeMetadata)	Signature of generated method is: public java.lang.Enum decode(int $1)
protected String	generateEnumEncodeMethodBody(ProtoEnumTypeMetadata enumTypeMetadata)	Signature of generated method is: public int encode(java.lang.Enum $1)
private void	generateFieldReadMethod(ProtoMessageTypeMetadata messageTypeMetadata, ProtoFieldMetadata fieldMetadata, IndentWriter iw, boolean noFactory, Map<String,Integer> trackedFields, String getUnknownFieldSetFieldStatement, String setUnknownFieldSetFieldStatement)
private String	generateMapFieldReadMethod(ProtoFieldMetadata fieldMetadata, IndentWriter iw, boolean readNext)
abstract void	generateMarshaller(SerializationContext serCtx, ProtoTypeMetadata ptm)
protected void	generateReadMethodBody(IndentWriter iw, ProtoMessageTypeMetadata messageTypeMetadata)	Signature of generated method is: public java.lang.Object read(org.infinispan.protostream.ProtoStreamMarshaller.ReadContext $1, java.lang.Object $2) throws java.io.IOException
protected void	generateWriteMethodBody(IndentWriter iw, ProtoMessageTypeMetadata messageTypeMetadata)	Signature of generated method is: public void write(org.infinispan.protostream.ProtoStreamMarshaller.WriteContext $1, java.lang.Object $2) throws java.io.IOException
private void	genSetField(IndentWriter iw, ProtoFieldMetadata fieldMetadata, Map<String,Integer> trackedFields, ProtoMessageTypeMetadata messageTypeMetadata)
private String	initMarshallerDelegateField(IndentWriter iw, ProtoFieldMetadata fieldMetadata)
private String	makeArrayLocalVar(ProtoFieldMetadata field)
private String	makeCollectionLocalVar(ProtoFieldMetadata field)	Make a collection local variable name for a repeatable/array field.
private String	makeFieldLocalVar(ProtoFieldMetadata field)	Make local variable name for a field.
private static String	makeFieldTag(int fieldNumber, WireType wireType)
private String	makeFieldWasSet(ProtoFieldMetadata field, Map<String,Integer> trackedFields)	Make statement to mark a field as set.
protected String	makeMarshallerDelegateFieldName(ProtoFieldMetadata field)	Make field name for caching a marshaller delegate for a related message.
protected String	makeQualifiedTypeName(String fullName)	Returns the protobuf qualified type name, including the package name.
private String	makeStreamIOMethodName(ProtoFieldMetadata fieldMetadata, boolean isWrite)
private String	makeTestFieldWasNotSet(Collection<ProtoFieldMetadata> fields, Map<String,Integer> trackedFields)	Make boolean expression to test that at least one fields from a given collection of fields was not set.
private String	makeTestFieldWasNotSet(ProtoFieldMetadata field, Map<String,Integer> trackedFields)	Make boolean expression to test that a field was not set.
private String	toJavaLiteral(Object value, XClass javaType)	Converts a given value instance to a Java language literal of type javaType.
private String	unbox(String v, XClass clazz)
private void	writeFieldValue(ProtoFieldMetadata fieldMetadata, IndentWriter iw, String v)
private void	writeFieldValue(ProtoFieldMetadata fieldMetadata, IndentWriter iw, String v, String out)

Methods inherited from class Object

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

Field Details

PROTOSTREAM_PACKAGE

private static final String PROTOSTREAM_PACKAGE

ADAPTER_FIELD_NAME

protected static final String ADAPTER_FIELD_NAME

See Also:

• Constant Field Values

typeFactory

private final XTypeFactory typeFactory

noDefaults

private final boolean noDefaults

Do nullable fields that do not have a user defined default value get a default type specific value if missing instead of just null? This is currently implemented just for arrays/collections. TODO Maybe numbers should also receive a 0 default value and booleans a false value. But what about strings? Empty string does not sound like a good fit. See the spec we do not fully implement here: Optional

See Also:

• Constant Field Values

protobufSchemaPackage

private final String protobufSchemaPackage

useGenerics

private final boolean useGenerics

See Also:

• Constant Field Values

Constructor Details

AbstractMarshallerCodeGenerator

protected AbstractMarshallerCodeGenerator(XTypeFactory typeFactory,
 String protobufSchemaPackage)

Method Details

generateEnumDecodeMethodBody

protected String generateEnumDecodeMethodBody(ProtoEnumTypeMetadata enumTypeMetadata)

Signature of generated method is: public java.lang.Enum decode(int $1)

generateEnumEncodeMethodBody

protected String generateEnumEncodeMethodBody(ProtoEnumTypeMetadata enumTypeMetadata)

Signature of generated method is: public int encode(java.lang.Enum $1)

makeQualifiedTypeName

protected String makeQualifiedTypeName(String fullName)

Returns the protobuf qualified type name, including the package name.

makeTestFieldWasNotSet

private String makeTestFieldWasNotSet(Collection<ProtoFieldMetadata> fields,
 Map<String,Integer> trackedFields)

Make boolean expression to test that at least one fields from a given collection of fields was not set.

makeTestFieldWasNotSet

private String makeTestFieldWasNotSet(ProtoFieldMetadata field,
 Map<String,Integer> trackedFields)

Make boolean expression to test that a field was not set.

makeFieldWasSet

private String makeFieldWasSet(ProtoFieldMetadata field,
 Map<String,Integer> trackedFields)

Make statement to mark a field as set.

makeFieldLocalVar

private String makeFieldLocalVar(ProtoFieldMetadata field)

Make local variable name for a field.

makeCollectionLocalVar

private String makeCollectionLocalVar(ProtoFieldMetadata field)

Make a collection local variable name for a repeatable/array field.

makeArrayLocalVar

private String makeArrayLocalVar(ProtoFieldMetadata field)

makeMarshallerDelegateFieldName

protected String makeMarshallerDelegateFieldName(ProtoFieldMetadata field)

Make field name for caching a marshaller delegate for a related message.

generateReadMethodBody

protected void generateReadMethodBody(IndentWriter iw,
 ProtoMessageTypeMetadata messageTypeMetadata)

Signature of generated method is: public java.lang.Object read(org.infinispan.protostream.ProtoStreamMarshaller.ReadContext $1, java.lang.Object $2) throws java.io.IOException

generateFieldReadMethod

private void generateFieldReadMethod(ProtoMessageTypeMetadata messageTypeMetadata,
 ProtoFieldMetadata fieldMetadata,
 IndentWriter iw,
 boolean noFactory,
 Map<String,Integer> trackedFields,
 String getUnknownFieldSetFieldStatement,
 String setUnknownFieldSetFieldStatement)

generateMapFieldReadMethod

private String generateMapFieldReadMethod(ProtoFieldMetadata fieldMetadata,
 IndentWriter iw,
 boolean readNext)

makeFieldTag

private static String makeFieldTag(int fieldNumber,
 WireType wireType)

toJavaLiteral

private String toJavaLiteral(Object value,
 XClass javaType)

Converts a given value instance to a Java language literal of type javaType. The input value is expected to conform to the given type (no checks are performed).

genSetField

private void genSetField(IndentWriter iw,
 ProtoFieldMetadata fieldMetadata,
 Map<String,Integer> trackedFields,
 ProtoMessageTypeMetadata messageTypeMetadata)

generateWriteMethodBody

protected void generateWriteMethodBody(IndentWriter iw,
 ProtoMessageTypeMetadata messageTypeMetadata)

Signature of generated method is: public void write(org.infinispan.protostream.ProtoStreamMarshaller.WriteContext $1, java.lang.Object $2) throws java.io.IOException

writeFieldValue

private void writeFieldValue(ProtoFieldMetadata fieldMetadata,
 IndentWriter iw,
 String v)

writeFieldValue

private void writeFieldValue(ProtoFieldMetadata fieldMetadata,
 IndentWriter iw,
 String v,
 String out)

initMarshallerDelegateField

private String initMarshallerDelegateField(IndentWriter iw,
 ProtoFieldMetadata fieldMetadata)

makeStreamIOMethodName

private String makeStreamIOMethodName(ProtoFieldMetadata fieldMetadata,
 boolean isWrite)

convert

private String convert(String v,
 ProtoFieldMetadata fieldMetadata)

Cast the given value if necessary. This is usually needed for the types that we are forced to represent as 32-bit integers because of Protobuf's lack of support for integral types of 8 and 16 bits.

box

private XClass box(XClass clazz)

Return the corresponding 'boxed' Class given a Class, or null if no type change is required.

box

private String box(String v,
 XClass clazz)

Boxes a given value. The Class parameter can be null to indicate that no boxing should actually be performed.

unbox

private String unbox(String v,
 XClass clazz)

createGetPropExpr

private String createGetPropExpr(ProtoMessageTypeMetadata messageTypeMetadata,
 ProtoFieldMetadata fieldMetadata,
 String obj)

createSetPropExpr

private String createSetPropExpr(ProtoMessageTypeMetadata messageTypeMetadata,
 ProtoFieldMetadata fieldMetadata,
 String obj,
 String value)

generateMarshaller

public abstract void generateMarshaller(SerializationContext serCtx,
 ProtoTypeMetadata ptm)
                                 throws Exception

Throws:

Exception