Class EnumDescriptor

java.lang.Object

org.infinispan.protostream.impl.AnnotatedDescriptorImpl

org.infinispan.protostream.descriptors.ReservableDescriptor

org.infinispan.protostream.descriptors.EnumDescriptor

All Implemented Interfaces:

AnnotatedDescriptor, GenericDescriptor

public final class EnumDescriptor
extends ReservableDescriptor
implements GenericDescriptor

Represents an enum in a proto file.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EnumDescriptor.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private Descriptor	containingType
private FileDescriptor	fileDescriptor
private final List<Option>	options
private Integer	typeId
private final Map<String, EnumValueDescriptor>	valueByName
private final Map<Integer, EnumValueDescriptor>	valueByNumber
private final List<EnumValueDescriptor>	values

Fields inherited from class ReservableDescriptor

reservedNames, reservedNumbers

Fields inherited from class AnnotatedDescriptorImpl

annotations, documentation, fullName, name, processedAnnotations

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EnumDescriptor(EnumDescriptor.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	checkCompatibility(EnumDescriptor that, boolean strict, List<String> errors)
private void	checkReserved(EnumValueDescriptor value)
EnumValueDescriptor	findValueByName(String name)
EnumValueDescriptor	findValueByNumber(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()
FileDescriptor	getFileDescriptor()	Return the containing files's descriptor
Option	getOption(String name)
List<Option>	getOptions()
Integer	getTypeId()
List<EnumValueDescriptor>	getValues()
(package 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, equals, finalize, getClass, hashCode, 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

values

private final List<EnumValueDescriptor> values

valueByNumber

private final Map<Integer, EnumValueDescriptor> valueByNumber

valueByName

private final Map<String, EnumValueDescriptor> valueByName

fileDescriptor

private FileDescriptor fileDescriptor

containingType

private Descriptor containingType

Constructor Details

EnumDescriptor

private EnumDescriptor(EnumDescriptor.Builder builder)

Method Details

checkReserved

private void checkReserved(EnumValueDescriptor value)

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

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)

getTypeId

public Integer getTypeId()

Specified by:

getTypeId in interface GenericDescriptor

getContainingType

public Descriptor getContainingType()

Specified by:

getContainingType in interface GenericDescriptor

setContainingType

void setContainingType(Descriptor containingType)

getOptions

public List<Option> getOptions()

getOption

public Option getOption(String name)

getValues

public List<EnumValueDescriptor> getValues()

findValueByNumber

public EnumValueDescriptor findValueByNumber(int number)

findValueByName

public EnumValueDescriptor findValueByName(String name)

setFileDescriptor

void setFileDescriptor(FileDescriptor fileDescriptor)

toString

public String toString()

Overrides:

toString in class Object

checkCompatibility

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