Field (protostuff :: parser 1.7.4 API)

java.lang.Object
- io.protostuff.parser.AnnotationContainer
- - io.protostuff.parser.Field<T>

All Implemented Interfaces:

HasAnnotations, HasName, HasOptions, HasProto, Comparable<Field<?>>

Direct Known Subclasses:

EnumField, Field.Bool, Field.Bytes, Field.Double, Field.Fixed32, Field.Fixed64, Field.Float, Field.Int32, Field.Int64, Field.Reference, Field.SFixed32, Field.SFixed64, Field.SInt32, Field.SInt64, Field.String, Field.UInt32, Field.UInt64, MessageField
```
public abstract class Field<T>
extends AnnotationContainer
implements Comparable<Field<?>>, HasName, HasOptions
```
Base class for fields defined in a Message.

Author:

David Yu

Date created:

Dec 19, 2009

Nested Class Summary

Nested Classes
Modifier and Type	Class and 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`
`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`

Constructor Summary

Constructors
Constructor and Description

Field()

Field(boolean packable)

Constructors
Constructor and Description
`Field()`
`Field(boolean packable)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Field<?> f)`
`T`	`getDefaultValue()`
`String`	`getDefaultValueAsString()`
`String`	`getDefaultValueConstant()`
`LinkedHashMap<String,Object>`	`getExtraOptions()`
`abstract String`	`getJavaType()`
`Field.Modifier`	`getModifier()`
`String`	`getName()`
`int`	`getNumber()`
`LinkedHashMap<String,Object>`	`getO()`
`<V> V`	`getOption(String key)` Returns the option defined by the `key`.
`LinkedHashMap<String,Object>`	`getOptions()` Returns this options
`Message`	`getOwner()`
`Proto`	`getProto()`
`String`	`getProtoType()` Returns field type for proto files.
`LinkedHashMap<String,Object>`	`getStandardOptions()`
`boolean`	`hasOption(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(String key, Object value)`
`void`	`putStandardOption(String key, Object value)`
`String`	`toString()`

Methods inherited from class io.protostuff.parser.AnnotationContainer
add, addAnnotations, addDoc, err, getA, getAnnotation, getAnnotationMap, getAnnotations, getDocs, hasAnnotation, isEmptyA

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Field
```
public Field()
```

Field
```
public Field(boolean packable)
```

Method Detail

getProto
```
public Proto getProto()
```
Specified by:

getProto in interface HasProto

getStandardOptions

public LinkedHashMap<String,Object> getStandardOptions()

getExtraOptions

public LinkedHashMap<String,Object> getExtraOptions()

getO

public LinkedHashMap<String,Object> getO()

getOptions
```
public LinkedHashMap<String,Object> getOptions()
```
Returns this options

Specified by:

getOptions in interface HasOptions

getOption
```
public <V> V getOption(String key)
```
Returns the option defined by the key.

hasOption
```
public boolean hasOption(String key)
```

putStandardOption

public void putStandardOption(String key,
                     Object value)

Specified by:: putStandardOption in interface HasOptions

putExtraOption

public void putExtraOption(String key,
                  Object value)

Specified by:: putExtraOption in interface HasOptions

getName
```
public String getName()
```
Specified by:

getName in interface HasName

Returns:
the name

getDefaultValueConstant

public 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 String toString()
```
Overrides:

toString in class Object

compareTo
```
public int compareTo(Field<?> f)
```
Specified by:

compareTo in interface Comparable<Field<?>>

getJavaType
```
public abstract String getJavaType()
```

getProtoType
```
public 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 String getDefaultValueAsString()

getOwner
```
public Message getOwner()
```

Class Field<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class io.protostuff.parser.AnnotationContainer

Methods inherited from class java.lang.Object

Constructor Detail

Field

Field

Method Detail

getProto

getStandardOptions

getExtraOptions

getO

getOptions

getOption

hasOption

putStandardOption

putExtraOption

getName

getDefaultValueConstant

getNumber

getModifier

isPackable

getDefaultValue

isRepeated

isRequired

isOptional

isDefaultValueSet

isNumberField

isEnumField

isMessageField

isBytesField

isStringField

isBoolField

isDelimited

toString

compareTo

getJavaType

getProtoType

getDefaultValueAsString

getOwner