MessageType._Builder (Providence Utils : Reflection 1.8.0 API)

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

All Implemented Interfaces:: PBuilder<MessageType>, BinaryReader

Enclosing class:: MessageType

public static class MessageType._Builder
extends PMessageBuilder<MessageType,MessageType._Field>
implements BinaryReader

<variant> { (<field> ([,;])?)* }

Constructor Summary

Constructors
Constructor and Description

_Builder()
Make a pmodel.MessageType builder instance.

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MessageType._Builder`	`addTo(int key, Object value)`
`MessageType._Builder`	`addToFields(FieldType... values)` Adds entries to the `fields` list.
`MessageType`	`build()`
`MessageType._Builder`	`clear(int key)`
`MessageType._Builder`	`clearAnnotations()` Clear the `annotations` field.
`MessageType._Builder`	`clearDocumentation()` Clear the `documentation` field.
`MessageType._Builder`	`clearEndPos()` Clear the `end_pos` field.
`MessageType._Builder`	`clearFields()` Clear the `fields` field.
`MessageType._Builder`	`clearName()` Clear the `name` field.
`MessageType._Builder`	`clearStartPos()` Clear the `start_pos` field.
`MessageType._Builder`	`clearVariant()` Clear the `variant` field.
`PStructDescriptor<MessageType,MessageType._Field>`	`descriptor()`
`boolean`	`equals(Object o)`
`String`	`getDocumentation()`
`FilePos`	`getEndPos()` The end of the definition (position of '}')
`String`	`getName()`
`FilePos`	`getStartPos()` The start of the definition (position of 'struct' / message type)
`MessageVariant`	`getVariant()`
`int`	`hashCode()`
`boolean`	`isModified(int key)`
`boolean`	`isModifiedAnnotations()` Checks if the `annotations` 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`	`isModifiedFields()` Checks if the `fields` 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`	`isModifiedStartPos()` Checks if the `start_pos` field has been modified since the builder was created.
`boolean`	`isModifiedVariant()` Checks if the `variant` field has been modified since the builder was created.
`boolean`	`isSet(int key)`
`boolean`	`isSetAnnotations()` Checks for presence of the `annotations` field.
`boolean`	`isSetDocumentation()` Checks for presence of the `documentation` field.
`boolean`	`isSetEndPos()` Checks for presence of the `end_pos` field.
`boolean`	`isSetFields()` Checks for presence of the `fields` field.
`boolean`	`isSetName()` Checks for presence of the `name` field.
`boolean`	`isSetStartPos()` Checks for presence of the `start_pos` field.
`boolean`	`isSetVariant()` Checks for presence of the `variant` field.
`MessageType._Builder`	`merge(MessageType 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.
`List<FieldType>`	`mutableFields()` Get the builder for the contained `fields` message field.
`FilePos._Builder`	`mutableStartPos()` Get the builder for the contained `start_pos` message field.
`PMessageBuilder`	`mutator(int key)`
`MessageType._Builder`	`putInAnnotations(String key, String value)` Adds a mapping to the `annotations` map.
`void`	`readBinary(net.morimekta.util.io.BigEndianBinaryReader reader, boolean strict)`
`MessageType._Builder`	`set(int key, Object value)`
`MessageType._Builder`	`setAnnotations(Map<String,String> value)` Set the `annotations` field value.
`MessageType._Builder`	`setDocumentation(String value)` Set the `documentation` field value.
`MessageType._Builder`	`setEndPos(FilePos._Builder builder)` Set the `end_pos` field value.
`MessageType._Builder`	`setEndPos(FilePos value)` Set the `end_pos` field value.
`MessageType._Builder`	`setFields(Collection<FieldType> value)` Set the `fields` field value.
`MessageType._Builder`	`setName(String value)` Set the `name` field value.
`MessageType._Builder`	`setStartPos(FilePos._Builder builder)` Set the `start_pos` field value.
`MessageType._Builder`	`setStartPos(FilePos value)` Set the `start_pos` field value.
`MessageType._Builder`	`setVariant(MessageVariant value)` Set the `variant` 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.MessageType builder instance.
  - _Builder
```
public _Builder(MessageType base)
```
    Make a mutating builder off a base pmodel.MessageType.
    
    Parameters:
    
    base - The base MessageType
- Method Detail
  - merge
```
@Nonnull
public MessageType._Builder merge(MessageType from)
```
    Specified by:
    
    merge in class PMessageBuilder<MessageType,MessageType._Field>
  - setDocumentation
```
@Nonnull
public MessageType._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 MessageType._Builder clearDocumentation()
```
    Clear the documentation field.
    
    Returns:
    
    The builder
  - getDocumentation
```
public String getDocumentation()
```
    Returns:
    
    The documentation field value
  - setVariant
```
@Nonnull
public MessageType._Builder setVariant(MessageVariant value)
```
    Set the variant field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - isSetVariant
```
public boolean isSetVariant()
```
    Checks for presence of the variant field.
    
    Returns:
    
    True if variant has been set.
  - isModifiedVariant
```
public boolean isModifiedVariant()
```
    Checks if the variant field has been modified since the builder was created.
    
    Returns:
    
    True if variant has been modified.
  - clearVariant
```
@Nonnull
public MessageType._Builder clearVariant()
```
    Clear the variant field.
    
    Returns:
    
    The builder
  - getVariant
```
public MessageVariant getVariant()
```
    Returns:
    
    The variant field value
  - setName
```
@Nonnull
public MessageType._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 MessageType._Builder clearName()
```
    Clear the name field.
    
    Returns:
    
    The builder
  - getName
```
public String getName()
```
    Returns:
    
    The name field value
  - setFields
```
@Nonnull
public MessageType._Builder setFields(Collection<FieldType> value)
```
    Set the fields field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - addToFields
```
@Nonnull
public MessageType._Builder addToFields(FieldType... values)
```
    Adds entries to the fields list.
    
    Parameters:
    
    values - The added value
    
    Returns:
    
    The builder
  - isSetFields
```
public boolean isSetFields()
```
    Checks for presence of the fields field.
    
    Returns:
    
    True if fields has been set.
  - isModifiedFields
```
public boolean isModifiedFields()
```
    Checks if the fields field has been modified since the builder was created.
    
    Returns:
    
    True if fields has been modified.
  - clearFields
```
@Nonnull
public MessageType._Builder clearFields()
```
    Clear the fields field.
    
    Returns:
    
    The builder
  - mutableFields
```
@Nonnull
public List<FieldType> mutableFields()
```
    Get the builder for the contained fields message field.
    
    Returns:
    
    The field message builder
  - setAnnotations
```
@Nonnull
public MessageType._Builder setAnnotations(Map<String,String> value)
```
    Set the annotations field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - putInAnnotations
```
@Nonnull
public MessageType._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 MessageType._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
  - setStartPos
```
@Nonnull
public MessageType._Builder setStartPos(FilePos value)
```
    Set the start_pos field value.
    The start of the definition (position of 'struct' / message type)
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - setStartPos
```
@Nonnull
public MessageType._Builder setStartPos(FilePos._Builder builder)
```
    Set the start_pos field value.
    The start of the definition (position of 'struct' / message type)
    
    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 MessageType._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 'struct' / message type)
    
    Returns:
    
    The field message builder
  - getStartPos
```
public FilePos getStartPos()
```
    The start of the definition (position of 'struct' / message type)
    
    Returns:
    
    The field value
  - setEndPos
```
@Nonnull
public MessageType._Builder setEndPos(FilePos value)
```
    Set the end_pos field value.
    The end of the definition (position of '}')
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - setEndPos
```
@Nonnull
public MessageType._Builder setEndPos(FilePos._Builder builder)
```
    Set the end_pos field value.
    The end of the definition (position of '}')
    
    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 MessageType._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 (position of '}')
    
    Returns:
    
    The field message builder
  - getEndPos
```
public FilePos getEndPos()
```
    The end of the definition (position of '}')
    
    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<MessageType,MessageType._Field>
  - set
```
@Nonnull
public MessageType._Builder set(int key,
                                         Object value)
```
    Specified by:
    
    set in class PMessageBuilder<MessageType,MessageType._Field>
  - isSet
```
public boolean isSet(int key)
```
    Specified by:
    
    isSet in class PMessageBuilder<MessageType,MessageType._Field>
  - isModified
```
public boolean isModified(int key)
```
    Specified by:
    
    isModified in class PMessageBuilder<MessageType,MessageType._Field>
  - addTo
```
public MessageType._Builder addTo(int key,
                                  Object value)
```
    Specified by:
    
    addTo in class PMessageBuilder<MessageType,MessageType._Field>
  - clear
```
@Nonnull
public MessageType._Builder clear(int key)
```
    Specified by:
    
    clear in class PMessageBuilder<MessageType,MessageType._Field>
  - valid
```
public boolean valid()
```
    Specified by:
    
    valid in class PMessageBuilder<MessageType,MessageType._Field>
  - validate
```
public void validate()
```
    Specified by:
    
    validate in class PMessageBuilder<MessageType,MessageType._Field>
  - descriptor
```
@Nonnull
public PStructDescriptor<MessageType,MessageType._Field> descriptor()
```
    Specified by:
    
    descriptor in class PMessageBuilder<MessageType,MessageType._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 MessageType build()
```
    Specified by:
    
    build in interface PBuilder<MessageType>

Class MessageType._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

setVariant

isSetVariant

isModifiedVariant

clearVariant

getVariant

setName

isSetName

isModifiedName

clearName

getName

setFields

addToFields

isSetFields

isModifiedFields

clearFields

mutableFields

setAnnotations

putInAnnotations

isSetAnnotations

isModifiedAnnotations

clearAnnotations

mutableAnnotations

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