Class FieldDescriptor
- java.lang.Object
-
- org.infinispan.protostream.impl.AnnotatedDescriptorImpl
-
- org.infinispan.protostream.descriptors.FieldDescriptor
-
- All Implemented Interfaces:
AnnotatedDescriptor
public final class FieldDescriptor extends AnnotatedDescriptorImpl implements AnnotatedDescriptor
Represents a field in a proto file.- Since:
- 2.0
- Author:
- gustavonalle, anistor@redhat.com
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFieldDescriptor.Builder
-
Field Summary
-
Fields inherited from class org.infinispan.protostream.impl.AnnotatedDescriptorImpl
annotations, documentation, fullName, name, processedAnnotations
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected AnnotationConfigurationgetAnnotationConfig(AnnotationElement.Annotation annotation)Subclasses are responsible for fetching theAnnotationConfigurationfrom the appropriate config (it it exists) and to validate that the target is suitable.DescriptorgetContainingMessage()ObjectgetDefaultValue()EnumDescriptorgetEnumType()FileDescriptorgetFileDescriptor()Return the containing files's descriptorJavaTypegetJavaType()LabelgetLabel()DescriptorgetMessageType()intgetNumber()OptiongetOption(String name)ObjectgetOptionByName(String name)List<Option>getOptions()TypegetType()StringgetTypeName()intgetWireTag()booleanhasDefaultValue()booleanisExtension()booleanisPacked()booleanisRepeated()booleanisRequired()StringtoString()-
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
-
-
-
-
Method Detail
-
getNumber
public int getNumber()
-
getWireTag
public int getWireTag()
-
getType
public Type getType()
-
getMessageType
public Descriptor getMessageType()
-
getLabel
public Label getLabel()
-
isRequired
public boolean isRequired()
-
isRepeated
public boolean isRepeated()
-
isPacked
public boolean isPacked()
-
getDefaultValue
public Object getDefaultValue()
-
isExtension
public boolean isExtension()
-
hasDefaultValue
public boolean hasDefaultValue()
-
getJavaType
public JavaType getJavaType()
-
getEnumType
public EnumDescriptor getEnumType()
-
getTypeName
public String getTypeName()
-
getFileDescriptor
public FileDescriptor getFileDescriptor()
Description copied from interface:AnnotatedDescriptorReturn the containing files's descriptor- Specified by:
getFileDescriptorin interfaceAnnotatedDescriptor- Returns:
- the containing files's descriptor (never
null)
-
getContainingMessage
public Descriptor getContainingMessage()
-
getAnnotationConfig
protected AnnotationConfiguration getAnnotationConfig(AnnotationElement.Annotation annotation)
Description copied from class:AnnotatedDescriptorImplSubclasses are responsible for fetching theAnnotationConfigurationfrom the appropriate config (it it exists) and to validate that the target is suitable.- Specified by:
getAnnotationConfigin classAnnotatedDescriptorImpl- Returns:
- null if the annotation is not found
-
-