FieldType._Builder (Providence Utils : Reflection 1.8.0 API)

java.lang.Object
- net.morimekta.providence.PMessageBuilder<FieldType,FieldType._Field>
- - net.morimekta.providence.model.FieldType._Builder

All Implemented Interfaces:

PBuilder<FieldType>, BinaryReader

Enclosing class:

FieldType
```
public static class FieldType._Builder
extends PMessageBuilder<FieldType,FieldType._Field>
implements BinaryReader
```
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'.

Constructor Summary

Constructors
Constructor and Description

_Builder()
Make a pmodel.FieldType builder instance.

_Builder(FieldType base)
Make a mutating builder off a base pmodel.FieldType.

Constructors
Constructor and Description
`_Builder()` Make a pmodel.FieldType builder instance.
`_Builder(FieldType base)` Make a mutating builder off a base pmodel.FieldType.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldType._Builder`	`addTo(int key, Object value)`
`FieldType`	`build()`
`FieldType._Builder`	`clear(int key)`
`FieldType._Builder`	`clearAnnotations()` Clear the `annotations` field.
`FieldType._Builder`	`clearDefaultValue()` Clear the `default_value` field.
`FieldType._Builder`	`clearDocumentation()` Clear the `documentation` field.
`FieldType._Builder`	`clearEndPos()` Clear the `end_pos` field.
`FieldType._Builder`	`clearId()` Clear the `id` field.
`FieldType._Builder`	`clearName()` Clear the `name` field.
`FieldType._Builder`	`clearRequirement()` Clear the `requirement` field.
`FieldType._Builder`	`clearStartPos()` Clear the `start_pos` field.
`FieldType._Builder`	`clearType()` Clear the `type` field.
`FieldType._Builder`	`clearValueStartPos()` Clear the `value_start_pos` field.
`PStructDescriptor<FieldType,FieldType._Field>`	`descriptor()`
`boolean`	`equals(Object o)`
`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.
`int`	`hashCode()`
`boolean`	`isModified(int key)`
`boolean`	`isModifiedAnnotations()` Checks if the `annotations` field has been modified since the builder was created.
`boolean`	`isModifiedDefaultValue()` Checks if the `default_value` field has been modified since the builder was created.
`boolean`	`isModifiedDocumentation()` Checks if the `documentation` field has been modified since the builder was created.
`boolean`	`isModifiedEndPos()` Checks if the `end_pos` field has been modified since the builder was created.
`boolean`	`isModifiedId()` Checks if the `id` field has been modified since the builder was created.
`boolean`	`isModifiedName()` Checks if the `name` field has been modified since the builder was created.
`boolean`	`isModifiedRequirement()` Checks if the `requirement` field has been modified since the builder was created.
`boolean`	`isModifiedStartPos()` Checks if the `start_pos` field has been modified since the builder was created.
`boolean`	`isModifiedType()` Checks if the `type` field has been modified since the builder was created.
`boolean`	`isModifiedValueStartPos()` Checks if the `value_start_pos` field has been modified since the builder was created.
`boolean`	`isSet(int key)`
`boolean`	`isSetAnnotations()` Checks for presence of the `annotations` field.
`boolean`	`isSetDefaultValue()` Checks for presence of the `default_value` field.
`boolean`	`isSetDocumentation()` Checks for presence of the `documentation` field.
`boolean`	`isSetEndPos()` Checks for presence of the `end_pos` field.
`boolean`	`isSetId()` Checks for presence of the `id` field.
`boolean`	`isSetName()` Checks for presence of the `name` field.
`boolean`	`isSetRequirement()` Checks for presence of the `requirement` field.
`boolean`	`isSetStartPos()` Checks for presence of the `start_pos` field.
`boolean`	`isSetType()` Checks for presence of the `type` field.
`boolean`	`isSetValueStartPos()` Checks for presence of the `value_start_pos` field.
`FieldType._Builder`	`merge(FieldType from)`
`Map<String,String>`	`mutableAnnotations()` Get the builder for the contained `annotations` message field.
`FilePos._Builder`	`mutableEndPos()` Get the builder for the contained `end_pos` message field.
`FilePos._Builder`	`mutableStartPos()` Get the builder for the contained `start_pos` message field.
`FilePos._Builder`	`mutableValueStartPos()` Get the builder for the contained `value_start_pos` message field.
`PMessageBuilder`	`mutator(int key)`
`FieldType._Builder`	`putInAnnotations(String key, String value)` Adds a mapping to the `annotations` map.
`void`	`readBinary(net.morimekta.util.io.BigEndianBinaryReader reader, boolean strict)`
`FieldType._Builder`	`set(int key, Object value)`
`FieldType._Builder`	`setAnnotations(Map<String,String> value)` Set the `annotations` field value.
`FieldType._Builder`	`setDefaultValue(String value)` Set the `default_value` field value.
`FieldType._Builder`	`setDocumentation(String value)` Set the `documentation` field value.
`FieldType._Builder`	`setEndPos(FilePos._Builder builder)` Set the `end_pos` field value.
`FieldType._Builder`	`setEndPos(FilePos value)` Set the `end_pos` field value.
`FieldType._Builder`	`setId(int value)` Set the `id` field value.
`FieldType._Builder`	`setName(String value)` Set the `name` field value.
`FieldType._Builder`	`setRequirement(FieldRequirement value)` Set the `requirement` field value.
`FieldType._Builder`	`setStartPos(FilePos._Builder builder)` Set the `start_pos` field value.
`FieldType._Builder`	`setStartPos(FilePos value)` Set the `start_pos` field value.
`FieldType._Builder`	`setType(String value)` Set the `type` field value.
`FieldType._Builder`	`setValueStartPos(FilePos._Builder builder)` Set the `value_start_pos` field value.
`FieldType._Builder`	`setValueStartPos(FilePos value)` Set the `value_start_pos` field value.
`boolean`	`valid()`
`void`	`validate()`

Methods inherited from class net.morimekta.providence.PMessageBuilder
addTo, clear, isModified, isSet, modifiedFields, mutator, presentFields, set

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

- Constructor Detail
  - _Builder
```
public _Builder()
```
    Make a pmodel.FieldType builder instance.
  - _Builder
```
public _Builder(FieldType base)
```
    Make a mutating builder off a base pmodel.FieldType.
    
    Parameters:
    
    base - The base FieldType
- Method Detail
  - merge
```
@Nonnull
public FieldType._Builder merge(FieldType from)
```
    Specified by:
    
    merge in class PMessageBuilder<FieldType,FieldType._Field>
  - setDocumentation
```
@Nonnull
public FieldType._Builder setDocumentation(String value)
```
    Set the documentation field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - isSetDocumentation
```
public boolean isSetDocumentation()
```
    Checks for presence of the documentation field.
    
    Returns:
    
    True if documentation has been set.
  - isModifiedDocumentation
```
public boolean isModifiedDocumentation()
```
    Checks if the documentation field has been modified since the builder was created.
    
    Returns:
    
    True if documentation has been modified.
  - clearDocumentation
```
@Nonnull
public FieldType._Builder clearDocumentation()
```
    Clear the documentation field.
    
    Returns:
    
    The builder
  - getDocumentation
```
public String getDocumentation()
```
    Returns:
    
    The documentation field value
  - setId
```
@Nonnull
public FieldType._Builder setId(int value)
```
    Set the id field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - isSetId
```
public boolean isSetId()
```
    Checks for presence of the id field.
    
    Returns:
    
    True if id has been set.
  - isModifiedId
```
public boolean isModifiedId()
```
    Checks if the id field has been modified since the builder was created.
    
    Returns:
    
    True if id has been modified.
  - clearId
```
@Nonnull
public FieldType._Builder clearId()
```
    Clear the id field.
    
    Returns:
    
    The builder
  - getId
```
public int getId()
```
    Returns:
    
    The id field value
  - setRequirement
```
@Nonnull
public FieldType._Builder setRequirement(FieldRequirement value)
```
    Set the requirement field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - isSetRequirement
```
public boolean isSetRequirement()
```
    Checks for presence of the requirement field.
    
    Returns:
    
    True if requirement has been set.
  - isModifiedRequirement
```
public boolean isModifiedRequirement()
```
    Checks if the requirement field has been modified since the builder was created.
    
    Returns:
    
    True if requirement has been modified.
  - clearRequirement
```
@Nonnull
public FieldType._Builder clearRequirement()
```
    Clear the requirement field.
    
    Returns:
    
    The builder
  - getRequirement
```
public FieldRequirement getRequirement()
```
    Returns:
    
    The requirement field value
  - setType
```
@Nonnull
public FieldType._Builder setType(String value)
```
    Set the type field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - isSetType
```
public boolean isSetType()
```
    Checks for presence of the type field.
    
    Returns:
    
    True if type has been set.
  - isModifiedType
```
public boolean isModifiedType()
```
    Checks if the type field has been modified since the builder was created.
    
    Returns:
    
    True if type has been modified.
  - clearType
```
@Nonnull
public FieldType._Builder clearType()
```
    Clear the type field.
    
    Returns:
    
    The builder
  - getType
```
public String getType()
```
    Returns:
    
    The type field value
  - setName
```
@Nonnull
public FieldType._Builder setName(String value)
```
    Set the name field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - isSetName
```
public boolean isSetName()
```
    Checks for presence of the name field.
    
    Returns:
    
    True if name has been set.
  - isModifiedName
```
public boolean isModifiedName()
```
    Checks if the name field has been modified since the builder was created.
    
    Returns:
    
    True if name has been modified.
  - clearName
```
@Nonnull
public FieldType._Builder clearName()
```
    Clear the name field.
    
    Returns:
    
    The builder
  - getName
```
public String getName()
```
    Returns:
    
    The name field value
  - setDefaultValue
```
@Nonnull
public FieldType._Builder setDefaultValue(String value)
```
    Set the default_value field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - isSetDefaultValue
```
public boolean isSetDefaultValue()
```
    Checks for presence of the default_value field.
    
    Returns:
    
    True if default_value has been set.
  - isModifiedDefaultValue
```
public boolean isModifiedDefaultValue()
```
    Checks if the default_value field has been modified since the builder was created.
    
    Returns:
    
    True if default_value has been modified.
  - clearDefaultValue
```
@Nonnull
public FieldType._Builder clearDefaultValue()
```
    Clear the default_value field.
    
    Returns:
    
    The builder
  - getDefaultValue
```
public String getDefaultValue()
```
    Returns:
    
    The default_value field value
  - setAnnotations
```
@Nonnull
public FieldType._Builder setAnnotations(Map<String,String> value)
```
    Set the annotations field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - putInAnnotations
```
@Nonnull
public FieldType._Builder putInAnnotations(String key,
                                                    String value)
```
    Adds a mapping to the annotations map.
    
    Parameters:
    
    key - The inserted key
    
    value - The inserted value
    
    Returns:
    
    The builder
  - isSetAnnotations
```
public boolean isSetAnnotations()
```
    Checks for presence of the annotations field.
    
    Returns:
    
    True if annotations has been set.
  - isModifiedAnnotations
```
public boolean isModifiedAnnotations()
```
    Checks if the annotations field has been modified since the builder was created.
    
    Returns:
    
    True if annotations has been modified.
  - clearAnnotations
```
@Nonnull
public FieldType._Builder clearAnnotations()
```
    Clear the annotations field.
    
    Returns:
    
    The builder
  - mutableAnnotations
```
@Nonnull
public Map<String,String> mutableAnnotations()
```
    Get the builder for the contained annotations message field.
    
    Returns:
    
    The field message builder
  - setValueStartPos
```
@Nonnull
public FieldType._Builder setValueStartPos(FilePos value)
```
    Set the value_start_pos field value.
    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.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - setValueStartPos
```
@Nonnull
public FieldType._Builder setValueStartPos(FilePos._Builder builder)
```
    Set the value_start_pos field value.
    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.
    
    Parameters:
    
    builder - builder for the new value
    
    Returns:
    
    The builder
  - isSetValueStartPos
```
public boolean isSetValueStartPos()
```
    Checks for presence of the value_start_pos field.
    
    Returns:
    
    True if value_start_pos has been set.
  - isModifiedValueStartPos
```
public boolean isModifiedValueStartPos()
```
    Checks if the value_start_pos field has been modified since the builder was created.
    
    Returns:
    
    True if value_start_pos has been modified.
  - clearValueStartPos
```
@Nonnull
public FieldType._Builder clearValueStartPos()
```
    Clear the value_start_pos field.
    
    Returns:
    
    The builder
  - mutableValueStartPos
```
@Nonnull
public FilePos._Builder mutableValueStartPos()
```
    Get the builder for the contained value_start_pos message field.
    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 message builder
  - 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 field value
  - setStartPos
```
@Nonnull
public FieldType._Builder setStartPos(FilePos value)
```
    Set the start_pos field value.
    The start of the definition (position of field ID)
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - setStartPos
```
@Nonnull
public FieldType._Builder setStartPos(FilePos._Builder builder)
```
    Set the start_pos field value.
    The start of the definition (position of field ID)
    
    Parameters:
    
    builder - builder for the new value
    
    Returns:
    
    The builder
  - isSetStartPos
```
public boolean isSetStartPos()
```
    Checks for presence of the start_pos field.
    
    Returns:
    
    True if start_pos has been set.
  - isModifiedStartPos
```
public boolean isModifiedStartPos()
```
    Checks if the start_pos field has been modified since the builder was created.
    
    Returns:
    
    True if start_pos has been modified.
  - clearStartPos
```
@Nonnull
public FieldType._Builder clearStartPos()
```
    Clear the start_pos field.
    
    Returns:
    
    The builder
  - mutableStartPos
```
@Nonnull
public FilePos._Builder mutableStartPos()
```
    Get the builder for the contained start_pos message field.
    The start of the definition (position of field ID)
    
    Returns:
    
    The field message builder
  - getStartPos
```
public FilePos getStartPos()
```
    The start of the definition (position of field ID)
    
    Returns:
    
    The field value
  - setEndPos
```
@Nonnull
public FieldType._Builder setEndPos(FilePos value)
```
    Set the end_pos field value.
    The end of the definition
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - setEndPos
```
@Nonnull
public FieldType._Builder setEndPos(FilePos._Builder builder)
```
    Set the end_pos field value.
    The end of the definition
    
    Parameters:
    
    builder - builder for the new value
    
    Returns:
    
    The builder
  - isSetEndPos
```
public boolean isSetEndPos()
```
    Checks for presence of the end_pos field.
    
    Returns:
    
    True if end_pos has been set.
  - isModifiedEndPos
```
public boolean isModifiedEndPos()
```
    Checks if the end_pos field has been modified since the builder was created.
    
    Returns:
    
    True if end_pos has been modified.
  - clearEndPos
```
@Nonnull
public FieldType._Builder clearEndPos()
```
    Clear the end_pos field.
    
    Returns:
    
    The builder
  - mutableEndPos
```
@Nonnull
public FilePos._Builder mutableEndPos()
```
    Get the builder for the contained end_pos message field.
    The end of the definition
    
    Returns:
    
    The field message builder
  - getEndPos
```
public FilePos getEndPos()
```
    The end of the definition
    
    Returns:
    
    The field value
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - mutator
```
public PMessageBuilder mutator(int key)
```
    Specified by:
    
    mutator in class PMessageBuilder<FieldType,FieldType._Field>
  - set
```
@Nonnull
public FieldType._Builder set(int key,
                                       Object value)
```
    Specified by:
    
    set in class PMessageBuilder<FieldType,FieldType._Field>
  - isSet
```
public boolean isSet(int key)
```
    Specified by:
    
    isSet in class PMessageBuilder<FieldType,FieldType._Field>
  - isModified
```
public boolean isModified(int key)
```
    Specified by:
    
    isModified in class PMessageBuilder<FieldType,FieldType._Field>
  - addTo
```
public FieldType._Builder addTo(int key,
                                Object value)
```
    Specified by:
    
    addTo in class PMessageBuilder<FieldType,FieldType._Field>
  - clear
```
@Nonnull
public FieldType._Builder clear(int key)
```
    Specified by:
    
    clear in class PMessageBuilder<FieldType,FieldType._Field>
  - valid
```
public boolean valid()
```
    Specified by:
    
    valid in class PMessageBuilder<FieldType,FieldType._Field>
  - validate
```
public void validate()
```
    Specified by:
    
    validate in class PMessageBuilder<FieldType,FieldType._Field>
  - descriptor
```
@Nonnull
public PStructDescriptor<FieldType,FieldType._Field> descriptor()
```
    Specified by:
    
    descriptor in class PMessageBuilder<FieldType,FieldType._Field>
  - readBinary
```
public void readBinary(net.morimekta.util.io.BigEndianBinaryReader reader,
                       boolean strict)
                throws IOException
```
    Specified by:
    
    readBinary in interface BinaryReader
    
    Throws:
    
    IOException
  - build
```
public FieldType build()
```
    Specified by:
    
    build in interface PBuilder<FieldType>

Class FieldType._Builder

Constructor Summary

Method Summary

Methods inherited from class net.morimekta.providence.PMessageBuilder

Methods inherited from class java.lang.Object

Constructor Detail

_Builder

_Builder

Method Detail

merge

setDocumentation

isSetDocumentation

isModifiedDocumentation

clearDocumentation

getDocumentation

setId

isSetId

isModifiedId

clearId

getId

setRequirement

isSetRequirement

isModifiedRequirement

clearRequirement

getRequirement

setType

isSetType

isModifiedType

clearType

getType

setName

isSetName

isModifiedName

clearName

getName

setDefaultValue

isSetDefaultValue

isModifiedDefaultValue

clearDefaultValue

getDefaultValue

setAnnotations

putInAnnotations

isSetAnnotations

isModifiedAnnotations

clearAnnotations

mutableAnnotations

setValueStartPos

setValueStartPos

isSetValueStartPos

isModifiedValueStartPos

clearValueStartPos

mutableValueStartPos

getValueStartPos

setStartPos

setStartPos

isSetStartPos

isModifiedStartPos

clearStartPos

mutableStartPos

getStartPos

setEndPos

setEndPos

isSetEndPos

isModifiedEndPos

clearEndPos

mutableEndPos

getEndPos

equals

hashCode

mutator

set

isSet

isModified

addTo

clear

valid

validate

descriptor

readBinary

build