Class Descriptor

java.lang.Object

org.infinispan.protostream.impl.AnnotatedDescriptorImpl

org.infinispan.protostream.descriptors.ReservableDescriptor

org.infinispan.protostream.descriptors.Descriptor

All Implemented Interfaces:

AnnotatedDescriptor, GenericDescriptor

public final class Descriptor
extends ReservableDescriptor
implements GenericDescriptor

Represents a message type declaration in a proto file.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Descriptor.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private Descriptor	containingType
private final List<FieldDescriptor>	fields
private final Map<String, FieldDescriptor>	fieldsByName
private final Map<Integer, FieldDescriptor>	fieldsByNumber
private FileDescriptor	fileDescriptor
private final List<EnumDescriptor>	nestedEnumTypes
private final List<Descriptor>	nestedMessageTypes
private final List<OneOfDescriptor>	oneofs
private final List<Option>	options
private Integer	typeId

Fields inherited from class ReservableDescriptor

reservedNames, reservedNumbers

Fields inherited from class AnnotatedDescriptorImpl

annotations, documentation, fullName, name, processedAnnotations

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Descriptor(Descriptor.Builder builder)

Method Summary

Modifier and Type	Method	Description
private void	addFields(List<? extends FieldDescriptor> fields)
void	checkCompatibility(Descriptor that, boolean strict, List<String> errors)
boolean	equals(Object o)
FieldDescriptor	findFieldByName(String name)
FieldDescriptor	findFieldByNumber(int number)
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	getContainingType()
List<EnumDescriptor>	getEnumTypes()
List<FieldDescriptor>	getFields()
FileDescriptor	getFileDescriptor()	Return the containing files's descriptor
List<Descriptor>	getNestedTypes()
List<OneOfDescriptor>	getOneOfs()
List<Option>	getOptions()
Integer	getTypeId()
int	hashCode()
boolean	isReserved(int number)
boolean	isReserved(String name)
private void	setContainingType(Descriptor containingType)
(package private) void	setFileDescriptor(FileDescriptor fileDescriptor)
String	toString()

Methods inherited from class ReservableDescriptor

checkReservation, getReservedNames, getReservedNumbers

Methods inherited from class AnnotatedDescriptorImpl

getAnnotations, getAnnotationsConfig, getDocumentation, getFullName, getName, getProcessedAnnotation

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AnnotatedDescriptor

getAnnotations, getDocumentation, getFullName, getName, getProcessedAnnotation

Field Details

typeId

private Integer typeId

options

private final List<Option> options

fields

private final List<FieldDescriptor> fields

oneofs

private final List<OneOfDescriptor> oneofs

nestedMessageTypes

private final List<Descriptor> nestedMessageTypes

nestedEnumTypes

private final List<EnumDescriptor> nestedEnumTypes

fieldsByNumber

private final Map<Integer, FieldDescriptor> fieldsByNumber

fieldsByName

private final Map<String, FieldDescriptor> fieldsByName

fileDescriptor

private FileDescriptor fileDescriptor

containingType

private Descriptor containingType

Constructor Details

Descriptor

private Descriptor(Descriptor.Builder builder)

Method Details

addFields

private void addFields(List<? extends FieldDescriptor> fields)

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)

getOptions

public List<Option> getOptions()

getFields

public List<FieldDescriptor> getFields()

getOneOfs

public List<OneOfDescriptor> getOneOfs()

getNestedTypes

public List<Descriptor> getNestedTypes()

getEnumTypes

public List<EnumDescriptor> getEnumTypes()

findFieldByNumber

public FieldDescriptor findFieldByNumber(int number)

findFieldByName

public FieldDescriptor findFieldByName(String name)

setFileDescriptor

void setFileDescriptor(FileDescriptor fileDescriptor)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeId

public Integer getTypeId()

Specified by:

getTypeId in interface GenericDescriptor

getContainingType

public Descriptor getContainingType()

Specified by:

getContainingType in interface GenericDescriptor

setContainingType

private void setContainingType(Descriptor containingType)

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

isReserved

public boolean isReserved(String name)

isReserved

public boolean isReserved(int number)

checkCompatibility

public void checkCompatibility(Descriptor that,
 boolean strict,
 List<String> errors)