Package io.protostuff.parser
Class Field<T>
- java.lang.Object
-
- io.protostuff.parser.AnnotationContainer
-
- io.protostuff.parser.Field<T>
-
- All Implemented Interfaces:
HasAnnotations
,HasName
,HasOptions
,HasProto
,java.lang.Comparable<Field<?>>
- Direct Known Subclasses:
EnumField
,Field.Bool
,Field.Bytes
,Field.Number
,Field.Reference
,Field.String
,MessageField
public abstract class Field<T> extends AnnotationContainer implements java.lang.Comparable<Field<?>>, HasName, HasOptions
Base class for fields defined in aMessage
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Field.Bool
static class
Field.Bytes
static class
Field.Double
static class
Field.Fixed32
static class
Field.Fixed64
static class
Field.Float
static class
Field.Int32
static class
Field.Int64
static class
Field.Modifier
(package private) static class
Field.Number<T>
static class
Field.Reference
static class
Field.SFixed32
static class
Field.SFixed64
static class
Field.SInt32
static class
Field.SInt64
static class
Field.String
static class
Field.UInt32
static class
Field.UInt64
-
Field Summary
Fields Modifier and Type Field Description (package private) T
defaultValue
(package private) java.lang.String
defaultValueConstant
(package private) java.util.LinkedHashMap<java.lang.String,java.lang.Object>
extraOptions
(package private) Field.Modifier
modifier
(package private) java.lang.String
name
(package private) int
number
(package private) Message
owner
(package private) boolean
packable
(package private) java.util.LinkedHashMap<java.lang.String,java.lang.Object>
standardOptions
-
Fields inherited from class io.protostuff.parser.AnnotationContainer
annotations, docs
-
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description int
compareTo(Field<?> f)
T
getDefaultValue()
java.lang.String
getDefaultValueAsString()
java.lang.String
getDefaultValueConstant()
java.util.LinkedHashMap<java.lang.String,java.lang.Object>
getExtraOptions()
abstract java.lang.String
getJavaType()
Field.Modifier
getModifier()
java.lang.String
getName()
int
getNumber()
java.util.LinkedHashMap<java.lang.String,java.lang.Object>
getO()
<V> V
getOption(java.lang.String key)
Returns the option defined by thekey
.java.util.LinkedHashMap<java.lang.String,java.lang.Object>
getOptions()
Returns this optionsMessage
getOwner()
Proto
getProto()
java.lang.String
getProtoType()
Returns field type for proto files.java.util.LinkedHashMap<java.lang.String,java.lang.Object>
getStandardOptions()
boolean
hasOption(java.lang.String key)
boolean
isBoolField()
boolean
isBytesField()
boolean
isDefaultValueSet()
boolean
isDelimited()
boolean
isEnumField()
boolean
isMessageField()
boolean
isNumberField()
boolean
isOptional()
boolean
isPackable()
boolean
isRepeated()
boolean
isRequired()
boolean
isStringField()
void
putExtraOption(java.lang.String key, java.lang.Object value)
void
putStandardOption(java.lang.String key, java.lang.Object value)
java.lang.String
toString()
-
Methods inherited from class io.protostuff.parser.AnnotationContainer
add, addAnnotations, addDoc, err, getA, getAnnotation, getAnnotationMap, getAnnotations, getDocs, hasAnnotation, isEmptyA
-
-
-
-
Field Detail
-
name
java.lang.String name
-
defaultValueConstant
java.lang.String defaultValueConstant
-
number
int number
-
modifier
Field.Modifier modifier
-
packable
boolean packable
-
defaultValue
T defaultValue
-
owner
Message owner
-
standardOptions
final java.util.LinkedHashMap<java.lang.String,java.lang.Object> standardOptions
-
extraOptions
final java.util.LinkedHashMap<java.lang.String,java.lang.Object> extraOptions
-
-
Method Detail
-
getStandardOptions
public java.util.LinkedHashMap<java.lang.String,java.lang.Object> getStandardOptions()
-
getExtraOptions
public java.util.LinkedHashMap<java.lang.String,java.lang.Object> getExtraOptions()
-
getO
public java.util.LinkedHashMap<java.lang.String,java.lang.Object> getO()
-
getOptions
public java.util.LinkedHashMap<java.lang.String,java.lang.Object> getOptions()
Returns this options- Specified by:
getOptions
in interfaceHasOptions
-
getOption
public <V> V getOption(java.lang.String key)
Returns the option defined by thekey
.
-
hasOption
public boolean hasOption(java.lang.String key)
-
putStandardOption
public void putStandardOption(java.lang.String key, java.lang.Object value)
- Specified by:
putStandardOption
in interfaceHasOptions
-
putExtraOption
public void putExtraOption(java.lang.String key, java.lang.Object value)
- Specified by:
putExtraOption
in interfaceHasOptions
-
getName
public java.lang.String getName()
-
getDefaultValueConstant
public java.lang.String getDefaultValueConstant()
-
getNumber
public int getNumber()
- Returns:
- the number
-
getModifier
public Field.Modifier getModifier()
- Returns:
- the modifier
-
isPackable
public boolean isPackable()
- Returns:
- the packable
-
getDefaultValue
public T getDefaultValue()
- Returns:
- the defaultValue
-
isRepeated
public boolean isRepeated()
-
isRequired
public boolean isRequired()
-
isOptional
public boolean isOptional()
-
isDefaultValueSet
public boolean isDefaultValueSet()
-
isNumberField
public boolean isNumberField()
-
isEnumField
public boolean isEnumField()
-
isMessageField
public boolean isMessageField()
-
isBytesField
public boolean isBytesField()
-
isStringField
public boolean isStringField()
-
isBoolField
public boolean isBoolField()
-
isDelimited
public boolean isDelimited()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
compareTo
public int compareTo(Field<?> f)
- Specified by:
compareTo
in interfacejava.lang.Comparable<T>
-
getJavaType
public abstract java.lang.String getJavaType()
-
getProtoType
public java.lang.String getProtoType()
Returns field type for proto files. Scalar value types: https://developers.google.com/protocol-buffers/docs/proto#scalar- Returns:
- .proto type
-
getDefaultValueAsString
public java.lang.String getDefaultValueAsString()
-
getOwner
public Message getOwner()
-
-