FieldType (Providence Utils : Reflection 1.8.0 API)

java.lang.Object
- net.morimekta.providence.model.FieldType

All Implemented Interfaces:

Serializable, Comparable<FieldType>, PMessage<FieldType,FieldType._Field>, PValue<FieldType>, BinaryWriter, net.morimekta.util.Stringable
```
@Generated(value="providence-maven-plugin")
 @Immutable
public class FieldType
extends Object
implements PMessage<FieldType,FieldType._Field>, Comparable<FieldType>, Serializable, BinaryWriter
```
For fields: (<key>:)? (required|optional)? <type> <name> (= <default_value>)? For const: const <type> <name> = <default_value>
Fields without key is assigned values ranging from 65335 and down (2^16-1) in order of appearance. Because of the "in order of appearance" the field *must* be filled by the IDL parser.
Consts are always given the key '0'.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FieldType._Builder
For fields: (<key>:)?

static class FieldType._Field

Nested Classes
Modifier and Type	Class and Description
`static class`	`FieldType._Builder` For fields: (<key>:)?
`static class`	`FieldType._Field`

Field Summary

Fields
Modifier and Type Field and Description

static PStructDescriptor<FieldType,FieldType._Field> kDescriptor

Fields
Modifier and Type	Field and Description
`static PStructDescriptor<FieldType,FieldType._Field>`	`kDescriptor`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`asString()`
`static FieldType._Builder`	`builder()` Make a `pmodel.FieldType` builder.
`int`	`compareTo(FieldType other)`
`PStructDescriptor<FieldType,FieldType._Field>`	`descriptor()`
`boolean`	`equals(Object o)`
`<T> T`	`get(int key)`
`Map<String,String>`	`getAnnotations()`
`String`	`getDefaultValue()`
`String`	`getDocumentation()`
`FilePos`	`getEndPos()` The end of the definition
`int`	`getId()`
`String`	`getName()`
`FieldRequirement`	`getRequirement()`
`FilePos`	`getStartPos()` The start of the definition (position of field ID)
`String`	`getType()`
`FilePos`	`getValueStartPos()` Note the start of the default value in the parsed thrift file, this can be used for making more accurate exception / parse data from the const parser.
`boolean`	`has(int key)`
`boolean`	`hasAnnotations()`
`boolean`	`hasDefaultValue()`
`boolean`	`hasDocumentation()`
`boolean`	`hasEndPos()`
`int`	`hashCode()`
`boolean`	`hasId()`
`boolean`	`hasName()`
`boolean`	`hasRequirement()`
`boolean`	`hasStartPos()`
`boolean`	`hasType()`
`boolean`	`hasValueStartPos()`
`FieldType._Builder`	`mutate()`
`int`	`numAnnotations()`
`Optional<Map<String,String>>`	`optionalAnnotations()`
`Optional<String>`	`optionalDefaultValue()`
`Optional<String>`	`optionalDocumentation()`
`Optional<FilePos>`	`optionalEndPos()` The end of the definition
`Optional<FieldRequirement>`	`optionalRequirement()`
`Optional<FilePos>`	`optionalStartPos()` The start of the definition (position of field ID)
`Optional<FilePos>`	`optionalValueStartPos()` Note the start of the default value in the parsed thrift file, this can be used for making more accurate exception / parse data from the const parser.
`static PStructDescriptorProvider<FieldType,FieldType._Field>`	`provider()`
`String`	`toString()`
`int`	`writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer)`

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

Methods inherited from interface net.morimekta.providence.PMessage
get, has, mergeWith

- Field Detail
  - kDescriptor
```
public static final PStructDescriptor<FieldType,FieldType._Field> kDescriptor
```
- Method Detail
  - hasDocumentation
```
public boolean hasDocumentation()
```
  - getDocumentation
```
public String getDocumentation()
```
    Returns:
    
    The documentation value
  - optionalDocumentation
```
@Nonnull
public Optional<String> optionalDocumentation()
```
    Returns:
    
    Optional of the documentation field value.
  - hasId
```
public boolean hasId()
```
  - getId
```
public int getId()
```
    Returns:
    
    The id value
  - hasRequirement
```
public boolean hasRequirement()
```
  - getRequirement
```
public FieldRequirement getRequirement()
```
    Returns:
    
    The requirement value
  - optionalRequirement
```
@Nonnull
public Optional<FieldRequirement> optionalRequirement()
```
    Returns:
    
    Optional of the requirement field value.
  - hasType
```
public boolean hasType()
```
  - getType
```
@Nonnull
public String getType()
```
    Returns:
    
    The type value
  - hasName
```
public boolean hasName()
```
  - getName
```
@Nonnull
public String getName()
```
    Returns:
    
    The name value
  - hasDefaultValue
```
public boolean hasDefaultValue()
```
  - getDefaultValue
```
public String getDefaultValue()
```
    Returns:
    
    The default_value value
  - optionalDefaultValue
```
@Nonnull
public Optional<String> optionalDefaultValue()
```
    Returns:
    
    Optional of the default_value field value.
  - numAnnotations
```
public int numAnnotations()
```
  - hasAnnotations
```
public boolean hasAnnotations()
```
  - getAnnotations
```
public Map<String,String> getAnnotations()
```
    Returns:
    
    The annotations value
  - optionalAnnotations
```
@Nonnull
public Optional<Map<String,String>> optionalAnnotations()
```
    Returns:
    
    Optional of the annotations field value.
  - hasValueStartPos
```
public boolean hasValueStartPos()
```
  - getValueStartPos
```
public FilePos getValueStartPos()
```
    Note the start of the default value in the parsed thrift file, this can be used for making more accurate exception / parse data from the const parser.
    
    Returns:
    
    The value_start_pos value
  - optionalValueStartPos
```
@Nonnull
public Optional<FilePos> optionalValueStartPos()
```
    Note the start of the default value in the parsed thrift file, this can be used for making more accurate exception / parse data from the const parser.
    
    Returns:
    
    Optional of the value_start_pos field value.
  - hasStartPos
```
public boolean hasStartPos()
```
  - getStartPos
```
public FilePos getStartPos()
```
    The start of the definition (position of field ID)
    
    Returns:
    
    The start_pos value
  - optionalStartPos
```
@Nonnull
public Optional<FilePos> optionalStartPos()
```
    The start of the definition (position of field ID)
    
    Returns:
    
    Optional of the start_pos field value.
  - hasEndPos
```
public boolean hasEndPos()
```
  - getEndPos
```
public FilePos getEndPos()
```
    The end of the definition
    
    Returns:
    
    The end_pos value
  - optionalEndPos
```
@Nonnull
public Optional<FilePos> optionalEndPos()
```
    The end of the definition
    
    Returns:
    
    Optional of the end_pos field value.
  - has
```
public boolean has(int key)
```
    Specified by:
    
    has in interface PMessage<FieldType,FieldType._Field>
  - get
```
public <T> T get(int key)
```
    Specified by:
    
    get in interface PMessage<FieldType,FieldType._Field>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - asString
```
@Nonnull
public String asString()
```
    Specified by:
    
    asString in interface PMessage<FieldType,FieldType._Field>
    
    Specified by:
    
    asString in interface net.morimekta.util.Stringable
  - compareTo
```
public int compareTo(FieldType other)
```
    Specified by:
    
    compareTo in interface Comparable<FieldType>
  - writeBinary
```
public int writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer)
                throws IOException
```
    Specified by:
    
    writeBinary in interface BinaryWriter
    
    Throws:
    
    IOException
  - mutate
```
@Nonnull
public FieldType._Builder mutate()
```
    Specified by:
    
    mutate in interface PMessage<FieldType,FieldType._Field>
  - provider
```
@Nonnull
public static PStructDescriptorProvider<FieldType,FieldType._Field> provider()
```
  - descriptor
```
@Nonnull
public PStructDescriptor<FieldType,FieldType._Field> descriptor()
```
    Specified by:
    
    descriptor in interface PMessage<FieldType,FieldType._Field>
    
    Specified by:
    
    descriptor in interface PValue<FieldType>
  - builder
```
public static FieldType._Builder builder()
```
    Make a pmodel.FieldType builder.
    
    Returns:
    
    The builder instance.

Class FieldType

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.morimekta.providence.PMessage

Field Detail

kDescriptor

Method Detail

hasDocumentation

getDocumentation

optionalDocumentation

hasId

getId

hasRequirement

getRequirement

optionalRequirement

hasType

getType

hasName

getName

hasDefaultValue

getDefaultValue

optionalDefaultValue

numAnnotations

hasAnnotations

getAnnotations

optionalAnnotations

hasValueStartPos

getValueStartPos

optionalValueStartPos

hasStartPos

getStartPos

optionalStartPos

hasEndPos

getEndPos

optionalEndPos

has

get

equals

hashCode

toString

asString

compareTo

writeBinary

mutate

provider

descriptor

builder