Class ProtoMessageTypeMetadata

java.lang.Object

org.infinispan.protostream.annotations.impl.ProtoTypeMetadata

org.infinispan.protostream.annotations.impl.ProtoMessageTypeMetadata

All Implemented Interfaces:

HasProtoSchema

Direct Known Subclasses:

CompileTimeProtoMessageTypeMetadata

public class ProtoMessageTypeMetadata
extends ProtoTypeMetadata

A ProtoTypeMetadata for a message type created based on annotations.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
private final XClass	annotatedClass
private static final byte[]	EMPTY_BYTES
private XExecutable	factory
private SortedMap<Integer, ProtoFieldMetadata>	fieldsByNumber
private final Map<XClass, ProtoTypeMetadata>	innerTypes
private final boolean	isAdapter
private final boolean	isIndexedContainer
private final boolean	isIterableContainer
private static final Log	log
private final BaseProtoSchemaGenerator	protoSchemaGenerator
protected final XTypeFactory	typeFactory
private XField	unknownFieldSetField
private XMethod	unknownFieldSetGetter
private XMethod	unknownFieldSetSetter

Fields inherited from class ProtoTypeMetadata

javaClass, name, outerType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProtoMessageTypeMetadata(BaseProtoSchemaGenerator protoSchemaGenerator, XClass annotatedClass, XClass javaClass)

Method Summary

Modifier and Type	Method	Description
protected void	addInnerType(ProtoTypeMetadata typeMetadata)
(package private) static byte[]	cescape(byte[] bytes)
(package private) static byte[]	cescape(Optional<String> s)	C-style escaping using 3 digit octal escapes ("\xxx") for all non-ASCII chars.
private void	checkForbiddenAnnotations(XMethod m1, XMethod m2)
private void	checkInstantiability()	Ensure we either have a suitable constructor or a factory method.
private static void	checkReserved(ProtoFieldMetadata fieldMetadata)
private Type	defaultType(ProtoField annotation, XClass type)
private String	detectPropertyNameFromSetter(XMethod method)
private String	determinePropertyNameFromGetter(XMethod method)
private void	discoverFields(XClass clazz, Set<XClass> examinedClasses, Map<Integer, ProtoFieldMetadata> fieldsByNumber, Map<String, ProtoFieldMetadata> fieldsByName, Set<String> oneofs)
private void	discoverFieldsFromClassFields(XClass clazz, Map<Integer, ProtoFieldMetadata> fieldsByNumber, Map<String, ProtoFieldMetadata> fieldsByName, Set<String> oneofs)
private void	discoverFieldsFromClassMethods(XClass clazz, Map<Integer, ProtoFieldMetadata> fieldsByNumber, Map<String, ProtoFieldMetadata> fieldsByName, Set<String> oneofs)
private void	discoverFieldsFromRecord(XClass clazz, Map<Integer, ProtoFieldMetadata> fieldsByNumber, Map<String, ProtoFieldMetadata> fieldsByName)
private XMethod	findGetter(String propertyName, XClass propertyType)
private XMethod	findSetter(String propertyName, XClass propertyType)
void	generateProto(IndentWriter iw, ProtoSyntax syntax)
XClass	getAnnotatedClass()	At this level we pretend the Java class and the annotated class are one and the same, but subclasses may decide otherwise.
private XClass	getCollectionImplementation(XClass clazz, XClass fieldType, XClass configuredCollection, String fieldName, boolean isRepeated)
protected XClass	getCollectionImplementationFromAnnotation(ProtoField annotation)
private Object	getDefaultValue(XClass clazz, String fieldName, XClass fieldType, Type protobufType, String value, boolean isRepeated)	Parses the value from string form (coming from proto schema) to an actual Java instance value, according to its type.
final ProtoEnumValueMetadata	getEnumMemberByName(String name)	This is only for enums.
ProtoEnumValueMetadata	getEnumMemberByNumber(int number)
XExecutable	getFactory()
private ProtoFieldMetadata	getFieldByPropertyName(String propName)
SortedMap<Integer, ProtoFieldMetadata>	getFields()
protected XClass	getJavaTypeFromAnnotation(ProtoField annotation)
private XClass	getMapImplementation(XClass clazz, XClass fieldType, XClass configuredMap, String fieldName, boolean isRepeated)
protected XClass	getMapImplementationFromAnnotation(ProtoField annotation)
private static String	getName(ProtoField annotation, XField field)
private static int	getNumber(ProtoField annotation, XMember member)
private Type	getProtobufType(XClass javaType, Type declaredType)
private static String	getProtoName(XClass annotatedClass, XClass javaClass)
XField	getUnknownFieldSetField()
XMethod	getUnknownFieldSetGetter()
XMethod	getUnknownFieldSetSetter()
boolean	isAdapter()
private boolean	isArray(XClass javaType, Type type)
boolean	isContainer()
final boolean	isEnum()
boolean	isIndexedContainer()
boolean	isIterableContainer()
private boolean	isMap(XClass javaType)
private boolean	isRepeated(XClass javaType, Type type)
private static int	parseInt(String value)
private static long	parseLong(String value)
void	scanMemberAnnotations()
String	toString()
private void	validateField(XClass clazz, XField field)
private String	validateOneOf(XClass clazz, Map<String, ProtoFieldMetadata> fieldsByName, Set<String> oneofs, ProtoField annotation, String fieldName, boolean isRepeated, boolean isRequired)

Methods inherited from class ProtoTypeMetadata

appendDocumentation, getAnnotatedClassName, getDocumentation, getFileName, getFullName, getJavaClass, getJavaClassName, getName, getOuterType, getProtoDocs, getProtoTypeId, getSubClassNames, isImported, setOuterType, validateName

Methods inherited from class Object

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

Field Details

EMPTY_BYTES

private static final byte[] EMPTY_BYTES

log

private static final Log log

protoSchemaGenerator

private final BaseProtoSchemaGenerator protoSchemaGenerator

typeFactory

protected final XTypeFactory typeFactory

fieldsByNumber

private SortedMap<Integer, ProtoFieldMetadata> fieldsByNumber

annotatedClass

private final XClass annotatedClass

isAdapter

private final boolean isAdapter

isIndexedContainer

private final boolean isIndexedContainer

isIterableContainer

private final boolean isIterableContainer

factory

private XExecutable factory

unknownFieldSetField

private XField unknownFieldSetField

unknownFieldSetGetter

private XMethod unknownFieldSetGetter

unknownFieldSetSetter

private XMethod unknownFieldSetSetter

innerTypes

private final Map<XClass, ProtoTypeMetadata> innerTypes

Constructor Details

ProtoMessageTypeMetadata

protected ProtoMessageTypeMetadata(BaseProtoSchemaGenerator protoSchemaGenerator,
 XClass annotatedClass,
 XClass javaClass)

Method Details

getProtoName

private static String getProtoName(XClass annotatedClass,
 XClass javaClass)

getAnnotatedClass

public XClass getAnnotatedClass()

Description copied from class: ProtoTypeMetadata

At this level we pretend the Java class and the annotated class are one and the same, but subclasses may decide otherwise.

Overrides:

getAnnotatedClass in class ProtoTypeMetadata

isAdapter

public boolean isAdapter()

Overrides:

isAdapter in class ProtoTypeMetadata

isIndexedContainer

public boolean isIndexedContainer()

isIterableContainer

public boolean isIterableContainer()

isContainer

public boolean isContainer()

getFactory

public XExecutable getFactory()

getUnknownFieldSetField

public XField getUnknownFieldSetField()

getUnknownFieldSetGetter

public XMethod getUnknownFieldSetGetter()

getUnknownFieldSetSetter

public XMethod getUnknownFieldSetSetter()

getFields

public SortedMap<Integer, ProtoFieldMetadata> getFields()

addInnerType

protected void addInnerType(ProtoTypeMetadata typeMetadata)

generateProto

public void generateProto(IndentWriter iw,
 ProtoSyntax syntax)

Specified by:

generateProto in interface HasProtoSchema

Overrides:

generateProto in class ProtoTypeMetadata

isEnum

public final boolean isEnum()

Specified by:

isEnum in class ProtoTypeMetadata

getEnumMemberByName

public final ProtoEnumValueMetadata getEnumMemberByName(String name)

Description copied from class: ProtoTypeMetadata

This is only for enums.

Specified by:

getEnumMemberByName in class ProtoTypeMetadata

getEnumMemberByNumber

public ProtoEnumValueMetadata getEnumMemberByNumber(int number)

Specified by:

getEnumMemberByNumber in class ProtoTypeMetadata

scanMemberAnnotations

public void scanMemberAnnotations()

Overrides:

scanMemberAnnotations in class ProtoTypeMetadata

getFieldByPropertyName

private ProtoFieldMetadata getFieldByPropertyName(String propName)

checkInstantiability

private void checkInstantiability()

Ensure we either have a suitable constructor or a factory method.

discoverFields

private void discoverFields(XClass clazz,
 Set<XClass> examinedClasses,
 Map<Integer, ProtoFieldMetadata> fieldsByNumber,
 Map<String, ProtoFieldMetadata> fieldsByName,
 Set<String> oneofs)

discoverFieldsFromClassMethods

private void discoverFieldsFromClassMethods(XClass clazz,
 Map<Integer, ProtoFieldMetadata> fieldsByNumber,
 Map<String, ProtoFieldMetadata> fieldsByName,
 Set<String> oneofs)

defaultType

private Type defaultType(ProtoField annotation,
 XClass type)

discoverFieldsFromClassFields

private void discoverFieldsFromClassFields(XClass clazz,
 Map<Integer, ProtoFieldMetadata> fieldsByNumber,
 Map<String, ProtoFieldMetadata> fieldsByName,
 Set<String> oneofs)

getName

private static String getName(ProtoField annotation,
 XField field)

validateOneOf

private String validateOneOf(XClass clazz,
 Map<String, ProtoFieldMetadata> fieldsByName,
 Set<String> oneofs,
 ProtoField annotation,
 String fieldName,
 boolean isRepeated,
 boolean isRequired)

validateField

private void validateField(XClass clazz,
 XField field)

detectPropertyNameFromSetter

private String detectPropertyNameFromSetter(XMethod method)

determinePropertyNameFromGetter

private String determinePropertyNameFromGetter(XMethod method)

discoverFieldsFromRecord

private void discoverFieldsFromRecord(XClass clazz,
 Map<Integer, ProtoFieldMetadata> fieldsByNumber,
 Map<String, ProtoFieldMetadata> fieldsByName)

getNumber

private static int getNumber(ProtoField annotation,
 XMember member)

checkReserved

private static void checkReserved(ProtoFieldMetadata fieldMetadata)

getCollectionImplementationFromAnnotation

protected XClass getCollectionImplementationFromAnnotation(ProtoField annotation)

getMapImplementationFromAnnotation

protected XClass getMapImplementationFromAnnotation(ProtoField annotation)

getJavaTypeFromAnnotation

protected XClass getJavaTypeFromAnnotation(ProtoField annotation)

getDefaultValue

private Object getDefaultValue(XClass clazz,
 String fieldName,
 XClass fieldType,
 Type protobufType,
 String value,
 boolean isRepeated)

Parses the value from string form (coming from proto schema) to an actual Java instance value, according to its type.

cescape

static byte[] cescape(Optional<String> s)

C-style escaping using 3 digit octal escapes ("\xxx") for all non-ASCII chars.

cescape

static byte[] cescape(byte[] bytes)

parseLong

private static long parseLong(String value)

parseInt

private static int parseInt(String value)

getCollectionImplementation

private XClass getCollectionImplementation(XClass clazz,
 XClass fieldType,
 XClass configuredCollection,
 String fieldName,
 boolean isRepeated)

getMapImplementation

private XClass getMapImplementation(XClass clazz,
 XClass fieldType,
 XClass configuredMap,
 String fieldName,
 boolean isRepeated)

getProtobufType

private Type getProtobufType(XClass javaType,
 Type declaredType)

isArray

private boolean isArray(XClass javaType,
 Type type)

isRepeated

private boolean isRepeated(XClass javaType,
 Type type)

isMap

private boolean isMap(XClass javaType)

findGetter

private XMethod findGetter(String propertyName,
 XClass propertyType)

findSetter

private XMethod findSetter(String propertyName,
 XClass propertyType)

checkForbiddenAnnotations

private void checkForbiddenAnnotations(XMethod m1,
 XMethod m2)

toString

public String toString()

Overrides:

toString in class Object