FieldType (Providence Utils : Reflection 1.5.2 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 model.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()`
`int`	`getId()`
`String`	`getName()`
`FieldRequirement`	`getRequirement()`
`int`	`getStartLineNo()` 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.
`int`	`getStartLinePos()`
`String`	`getType()`
`boolean`	`has(int key)`
`boolean`	`hasAnnotations()`
`boolean`	`hasDefaultValue()`
`boolean`	`hasDocumentation()`
`int`	`hashCode()`
`boolean`	`hasId()`
`boolean`	`hasName()`
`boolean`	`hasRequirement()`
`boolean`	`hasStartLineNo()`
`boolean`	`hasStartLinePos()`
`boolean`	`hasType()`
`FieldType._Builder`	`mutate()`
`int`	`numAnnotations()`
`Optional<Map<String,String>>`	`optionalAnnotations()`
`Optional<String>`	`optionalDefaultValue()`
`Optional<String>`	`optionalDocumentation()`
`Optional<FieldRequirement>`	`optionalRequirement()`
`OptionalInt`	`optionalStartLineNo()` 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.
`OptionalInt`	`optionalStartLinePos()`
`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 field value
  - optionalDocumentation
```
@Nonnull
public Optional<String> optionalDocumentation()
```
    Returns:
    
    Optional field value
  - hasId
```
public boolean hasId()
```
  - getId
```
public int getId()
```
    Returns:
    
    The field value
  - hasRequirement
```
public boolean hasRequirement()
```
  - getRequirement
```
public FieldRequirement getRequirement()
```
    Returns:
    
    The field value
  - optionalRequirement
```
@Nonnull
public Optional<FieldRequirement> optionalRequirement()
```
    Returns:
    
    Optional field value
  - hasType
```
public boolean hasType()
```
  - getType
```
@Nonnull
public String getType()
```
    Returns:
    
    The field value
  - hasName
```
public boolean hasName()
```
  - getName
```
@Nonnull
public String getName()
```
    Returns:
    
    The field value
  - hasDefaultValue
```
public boolean hasDefaultValue()
```
  - getDefaultValue
```
public String getDefaultValue()
```
    Returns:
    
    The field value
  - optionalDefaultValue
```
@Nonnull
public Optional<String> optionalDefaultValue()
```
    Returns:
    
    Optional field value
  - numAnnotations
```
public int numAnnotations()
```
  - hasAnnotations
```
public boolean hasAnnotations()
```
  - getAnnotations
```
public Map<String,String> getAnnotations()
```
    Returns:
    
    The field value
  - optionalAnnotations
```
@Nonnull
public Optional<Map<String,String>> optionalAnnotations()
```
    Returns:
    
    Optional field value
  - hasStartLineNo
```
public boolean hasStartLineNo()
```
  - getStartLineNo
```
public int getStartLineNo()
```
    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 field value
  - optionalStartLineNo
```
@Nonnull
public OptionalInt optionalStartLineNo()
```
    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 field value
  - hasStartLinePos
```
public boolean hasStartLinePos()
```
  - getStartLinePos
```
public int getStartLinePos()
```
    Returns:
    
    The field value
  - optionalStartLinePos
```
@Nonnull
public OptionalInt optionalStartLinePos()
```
    Returns:
    
    Optional 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 model.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

hasStartLineNo

getStartLineNo

optionalStartLineNo

hasStartLinePos

getStartLinePos

optionalStartLinePos

has

get

equals

hashCode

toString

asString

compareTo

writeBinary

mutate

provider

descriptor

builder