Package org.infinispan.protostream.annotations.impl

Class ProtoTypeMetadata

java.lang.Object

org.infinispan.protostream.annotations.impl.ProtoTypeMetadata

All Implemented Interfaces:

HasProtoSchema

Direct Known Subclasses:

CompileTimeImportedProtoTypeMetadata, ImportedProtoTypeMetadata, ProtoEnumTypeMetadata, ProtoMessageTypeMetadata

public abstract class ProtoTypeMetadata
extends Object
implements HasProtoSchema

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final XClass	javaClass	The marshalled Java class.
protected final String	name
protected ProtoMessageTypeMetadata	outerType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProtoTypeMetadata(String name, XClass javaClass)

Method Summary

Modifier and Type	Method	Description
protected static void	appendDocumentation(IndentWriter iw, String documentation)
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.
String	getAnnotatedClassName()
String	getDocumentation()
abstract ProtoEnumValueMetadata	getEnumMemberByName(String name)	This is only for enums.
abstract ProtoEnumValueMetadata	getEnumMemberByNumber(int number)
String	getFileName()	The schema file where this type comes from.
String	getFullName()
XClass	getJavaClass()
String	getJavaClassName()
String	getName()
final ProtoMessageTypeMetadata	getOuterType()
String	getProtoDocs()
Integer	getProtoTypeId()
String[]	getSubClassNames()
boolean	isAdapter()
abstract boolean	isEnum()
boolean	isImported()	Indicates if this type comes from the currently processed/generated schema of from an external schema.
void	scanMemberAnnotations()
protected final void	setOuterType(ProtoMessageTypeMetadata outerType)
protected void	validateName()

Methods inherited from class java.lang.Object

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

Field Details

name

protected final String name

javaClass

protected final XClass javaClass

The marshalled Java class.

outerType

protected ProtoMessageTypeMetadata outerType

Constructor Details

ProtoTypeMetadata

protected ProtoTypeMetadata(String name,
 XClass javaClass)

Method Details

validateName

protected void validateName()

getName

public String getName()

getFullName

public String getFullName()

getDocumentation

public String getDocumentation()

getProtoDocs

public String getProtoDocs()

getProtoTypeId

public Integer getProtoTypeId()

getJavaClass

public XClass getJavaClass()

getJavaClassName

public String getJavaClassName()

getSubClassNames

public String[] getSubClassNames()

getAnnotatedClass

public XClass getAnnotatedClass()

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

getAnnotatedClassName

public String getAnnotatedClassName()

isAdapter

public boolean isAdapter()

isImported

public boolean isImported()

Indicates if this type comes from the currently processed/generated schema of from an external schema.

getFileName

public String getFileName()

The schema file where this type comes from. Must be non-null for all imported types, can be null for others.

isEnum

public abstract boolean isEnum()

getEnumMemberByName

public abstract ProtoEnumValueMetadata getEnumMemberByName(String name)

This is only for enums.

getEnumMemberByNumber

public abstract ProtoEnumValueMetadata getEnumMemberByNumber(int number)

getOuterType

public final ProtoMessageTypeMetadata getOuterType()

setOuterType

protected final void setOuterType(ProtoMessageTypeMetadata outerType)

generateProto

public void generateProto(IndentWriter iw,
 ProtoSyntax syntax)

Specified by:

generateProto in interface HasProtoSchema

scanMemberAnnotations

public void scanMemberAnnotations()

appendDocumentation

protected static void appendDocumentation(IndentWriter iw,
 String documentation)