Package org.infinispan.protostream.descriptors

Class FieldDescriptor

java.lang.Object

org.infinispan.protostream.impl.AnnotatedDescriptorImpl

org.infinispan.protostream.descriptors.FieldDescriptor

All Implemented Interfaces:

AnnotatedDescriptor

Direct Known Subclasses:

MapDescriptor, RepeatedFieldDescriptor

public class FieldDescriptor
extends AnnotatedDescriptorImpl
implements AnnotatedDescriptor

Represents a field in a proto file.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldDescriptor.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected Descriptor	containingMessage
protected final String	defaultValue
protected EnumDescriptor	enumType
protected FileDescriptor	fileDescriptor
protected final Label	label
protected Descriptor	messageType
protected final int	number
protected final List<Option>	options
protected Type	type
protected final String	typeName

Fields inherited from class org.infinispan.protostream.impl.AnnotatedDescriptorImpl

annotations, documentation, fullName, name, processedAnnotations

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldDescriptor(FieldDescriptor.Builder builder)

Method Summary

Modifier and Type	Method	Description
protected AnnotationConfiguration	getAnnotationConfig(AnnotationElement.Annotation annotation)	Subclasses are responsible for fetching the AnnotationConfiguration from the appropriate config (it it exists) and to validate that the target is suitable.
Descriptor	getContainingMessage()
Object	getDefaultValue()
EnumDescriptor	getEnumType()
FileDescriptor	getFileDescriptor()	Return the containing files's descriptor
JavaType	getJavaType()
Label	getLabel()
Descriptor	getMessageType()
int	getNumber()
Option	getOptionByName(String name)
List<Option>	getOptions()
Type	getType()
String	getTypeName()
int	getWireTag()
boolean	hasDefaultValue()
boolean	isMap()
boolean	isRepeated()
(package private) void	setContainingMessage(Descriptor containingMessage)
(package private) void	setEnumType(EnumDescriptor enumDescriptor)
(package private) void	setFileDescriptor(FileDescriptor fileDescriptor)
(package private) void	setMessageType(Descriptor descriptor)
String	toString()

Methods inherited from class org.infinispan.protostream.impl.AnnotatedDescriptorImpl

getAnnotations, getAnnotationsConfig, getDocumentation, getFullName, getName, getProcessedAnnotation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.protostream.descriptors.AnnotatedDescriptor

getAnnotations, getDocumentation, getFullName, getName, getProcessedAnnotation

Field Details

number

protected final int number

label

protected final Label label

typeName

protected final String typeName

defaultValue

protected final String defaultValue

options

protected final List<Option> options

type

protected Type type

fileDescriptor

protected FileDescriptor fileDescriptor

containingMessage

protected Descriptor containingMessage

messageType

protected Descriptor messageType

enumType

protected EnumDescriptor enumType

Constructor Details

FieldDescriptor

protected FieldDescriptor(FieldDescriptor.Builder builder)

Method Details

getNumber

public int getNumber()

getWireTag

public int getWireTag()

getType

public Type getType()

getMessageType

public Descriptor getMessageType()

getLabel

public Label getLabel()

getOptionByName

public Option getOptionByName(String name)

getOptions

public List<Option> getOptions()

isRepeated

public boolean isRepeated()

isMap

public boolean isMap()

getJavaType

public JavaType getJavaType()

getEnumType

public EnumDescriptor getEnumType()

getTypeName

public String getTypeName()

getFileDescriptor

public FileDescriptor getFileDescriptor()

Description copied from interface: AnnotatedDescriptor

Return the containing files's descriptor

Specified by:

getFileDescriptor in interface AnnotatedDescriptor

Returns:

the containing files's descriptor (never null)

getContainingMessage

public Descriptor getContainingMessage()

setContainingMessage

void setContainingMessage(Descriptor containingMessage)

setMessageType

void setMessageType(Descriptor descriptor)

setEnumType

void setEnumType(EnumDescriptor enumDescriptor)

setFileDescriptor

void setFileDescriptor(FileDescriptor fileDescriptor)

getAnnotationConfig

protected AnnotationConfiguration getAnnotationConfig(AnnotationElement.Annotation annotation)

Description copied from class: AnnotatedDescriptorImpl

Subclasses are responsible for fetching the AnnotationConfiguration from the appropriate config (it it exists) and to validate that the target is suitable.

Specified by:

getAnnotationConfig in class AnnotatedDescriptorImpl

Returns:

null if the annotation is not found

toString

public String toString()

Overrides:

toString in class Object

hasDefaultValue

public boolean hasDefaultValue()

getDefaultValue

public Object getDefaultValue()