FunctionType._Builder (Providence Generator : Common 2.6.1 API)

java.lang.Object
- net.morimekta.providence.PMessageBuilder<FunctionType>
- - net.morimekta.providence.model.FunctionType._Builder

All Implemented Interfaces:

Decl, Decl._Builder, FunctionType_OrBuilder, net.morimekta.providence.PMessageOrBuilder<FunctionType>, net.morimekta.providence.PValue<FunctionType>, net.morimekta.providence.serializer.binary.BinaryReader

Enclosing class:

FunctionType
```
public static class FunctionType._Builder
extends net.morimekta.providence.PMessageBuilder<FunctionType>
implements Decl._Builder, FunctionType_OrBuilder, net.morimekta.providence.serializer.binary.BinaryReader
```
(oneway)? <return_type> <name>'('<param>*')' (throws '(' <exception>+ ')')?

Nested Class Summary
- Nested classes/interfaces inherited from interface net.morimekta.providence.model.Decl
  Decl._Builder, Decl._Field

Field Summary
- Fields inherited from interface net.morimekta.providence.model.Decl
  kDescriptor

Constructor Summary

Constructors
Constructor and Description

_Builder()
Make a p_model.FunctionType builder instance.

_Builder(FunctionType base)
Make a mutating builder off a base p_model.FunctionType.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FunctionType._Builder`	`addTo(int key, Object value)`
`FunctionType._Builder`	`addToExceptions(FieldType... values)` Adds entries to the `exceptions` list.
`FunctionType._Builder`	`addToParams(FieldType... values)` Adds entries to the `params` list.
`FunctionType`	`build()`
`FunctionType._Builder`	`clear(int key)`
`FunctionType._Builder`	`clearAnnotations()` Clear the `annotations` field.
`FunctionType._Builder`	`clearDocumentation()` Clear the `documentation` field.
`FunctionType._Builder`	`clearExceptions()` Clear the `exceptions` field.
`FunctionType._Builder`	`clearName()` Clear the `name` field.
`FunctionType._Builder`	`clearOneWay()` Clear the `one_way` field.
`FunctionType._Builder`	`clearParams()` Clear the `params` field.
`FunctionType._Builder`	`clearReturnType()` Clear the `return_type` field.
`net.morimekta.providence.descriptor.PStructDescriptor<FunctionType>`	`descriptor()`
`boolean`	`equals(Object o)`
`<T> T`	`get(int key)`
`Map<String,String>`	`getAnnotations()`
`String`	`getDocumentation()` Documentation for the specific declaration.
`List<FieldType>`	`getExceptions()`
`String`	`getName()` Name of the type, constant or service.
`List<FieldType>`	`getParams()`
`String`	`getReturnType()`
`boolean`	`has(int key)`
`boolean`	`hasAnnotations()` Checks for presence of the `annotations` field.
`boolean`	`hasDocumentation()` Checks for presence of the `documentation` field.
`boolean`	`hasExceptions()` Checks for presence of the `exceptions` field.
`int`	`hashCode()`
`boolean`	`hasName()` Checks for presence of the `name` field.
`boolean`	`hasOneWay()` Checks for presence of the `one_way` field.
`boolean`	`hasParams()` Checks for presence of the `params` field.
`boolean`	`hasReturnType()` Checks for presence of the `return_type` field.
`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`	`isModifiedExceptions()` Checks if the `exceptions` 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`	`isModifiedOneWay()` Checks if the `one_way` field has been modified since the builder was created.
`boolean`	`isModifiedParams()` Checks if the `params` field has been modified since the builder was created.
`boolean`	`isModifiedReturnType()` Checks if the `return_type` field has been modified since the builder was created.
`boolean`	`isOneWay()`
`boolean`	`isSet(int key)`
`boolean`	`isSetAnnotations()` Checks for explicit presence of the `annotations` field.
`boolean`	`isSetDocumentation()` Checks for explicit presence of the `documentation` field.
`boolean`	`isSetExceptions()` Checks for explicit presence of the `exceptions` field.
`boolean`	`isSetName()` Checks for explicit presence of the `name` field.
`boolean`	`isSetOneWay()` Checks for explicit presence of the `one_way` field.
`boolean`	`isSetParams()` Checks for explicit presence of the `params` field.
`boolean`	`isSetReturnType()` Checks for explicit presence of the `return_type` field.
`FunctionType._Builder`	`merge(FunctionType from)`
`Map<String,String>`	`mutableAnnotations()`
`List<FieldType>`	`mutableExceptions()`
`List<FieldType>`	`mutableParams()`
`net.morimekta.providence.PMessageBuilder`	`mutator(int key)`
`int`	`numAnnotations()`
`int`	`numExceptions()`
`int`	`numParams()`
`Optional<Map<String,String>>`	`optionalAnnotations()`
`Optional<String>`	`optionalDocumentation()` Documentation for the specific declaration.
`Optional<List<FieldType>>`	`optionalExceptions()`
`Optional<Boolean>`	`optionalOneWay()`
`Optional<String>`	`optionalReturnType()`
`FunctionType._Builder`	`putInAnnotations(String key, String value)` Adds a mapping to the `annotations` map.
`void`	`readBinary(net.morimekta.util.io.BigEndianBinaryReader reader, boolean strict)`
`FunctionType._Builder`	`set(int key, Object value)`
`FunctionType._Builder`	`setAnnotations(Map<String,String> value)` Set the `annotations` field value.
`FunctionType._Builder`	`setDocumentation(String value)` Set the `documentation` field value.
`FunctionType._Builder`	`setExceptions(Collection<FieldType> value)` Set the `exceptions` field value.
`FunctionType._Builder`	`setName(String value)` Set the `name` field value.
`FunctionType._Builder`	`setOneWay(boolean value)` Set the `one_way` field value.
`FunctionType._Builder`	`setOneWay(Boolean value)` Set the `one_way` field value.
`FunctionType._Builder`	`setParams(Collection<FieldType> value)` Set the `params` field value.
`FunctionType._Builder`	`setReturnType(String value)` Set the `return_type` field value.
`boolean`	`valid()`
`FunctionType._Builder`	`validate()`

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

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

Methods inherited from interface net.morimekta.providence.PMessageOrBuilder
get, has, toBuilder, toMessage

- Constructor Detail
  - _Builder
```
public _Builder()
```
    Make a p_model.FunctionType builder instance.
  - _Builder
```
public _Builder(FunctionType base)
```
    Make a mutating builder off a base p_model.FunctionType.
    
    Parameters:
    
    base - The base FunctionType
- Method Detail
  - merge
```
@Nonnull
public FunctionType._Builder merge(FunctionType from)
```
    Specified by:
    
    merge in class net.morimekta.providence.PMessageBuilder<FunctionType>
  - setDocumentation
```
@Nonnull
public FunctionType._Builder setDocumentation(String value)
```
    Set the documentation field value.
    
    Specified by:
    
    setDocumentation in interface Decl._Builder
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - isSetDocumentation
```
public boolean isSetDocumentation()
```
    Checks for explicit presence of the documentation field.
    
    Returns:
    
    True if documentation has been set.
  - hasDocumentation
```
public boolean hasDocumentation()
```
    Checks for presence of the documentation field.
    
    Specified by:
    
    hasDocumentation in interface Decl
    
    Returns:
    
    True if documentation is present.
  - 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 FunctionType._Builder clearDocumentation()
```
    Clear the documentation field.
    
    Specified by:
    
    clearDocumentation in interface Decl._Builder
    
    Returns:
    
    The builder
  - getDocumentation
```
public String getDocumentation()
```
    Description copied from interface: Decl
    
    Documentation for the specific declaration.
    
    Specified by:
    
    getDocumentation in interface Decl
    
    Returns:
    
    The documentation field value
  - optionalDocumentation
```
@Nonnull
public Optional<String> optionalDocumentation()
```
    Description copied from interface: Decl
    
    Documentation for the specific declaration.
    
    Specified by:
    
    optionalDocumentation in interface Decl
    
    Returns:
    
    Optional documentation field value
  - setOneWay
```
@Nonnull
public FunctionType._Builder setOneWay(Boolean value)
```
    Set the one_way field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - setOneWay
```
@Nonnull
public FunctionType._Builder setOneWay(boolean value)
```
    Set the one_way field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - isSetOneWay
```
public boolean isSetOneWay()
```
    Checks for explicit presence of the one_way field.
    
    Returns:
    
    True if one_way has been set.
  - hasOneWay
```
public boolean hasOneWay()
```
    Checks for presence of the one_way field.
    
    Specified by:
    
    hasOneWay in interface FunctionType_OrBuilder
    
    Returns:
    
    True if one_way is present.
  - isModifiedOneWay
```
public boolean isModifiedOneWay()
```
    Checks if the one_way field has been modified since the builder was created.
    
    Returns:
    
    True if one_way has been modified.
  - clearOneWay
```
@Nonnull
public FunctionType._Builder clearOneWay()
```
    Clear the one_way field.
    
    Returns:
    
    The builder
  - isOneWay
```
public boolean isOneWay()
```
    Specified by:
    
    isOneWay in interface FunctionType_OrBuilder
    
    Returns:
    
    The one_way field value
  - optionalOneWay
```
@Nonnull
public Optional<Boolean> optionalOneWay()
```
    Specified by:
    
    optionalOneWay in interface FunctionType_OrBuilder
    
    Returns:
    
    Optional one_way field value
  - setReturnType
```
@Nonnull
public FunctionType._Builder setReturnType(String value)
```
    Set the return_type field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - isSetReturnType
```
public boolean isSetReturnType()
```
    Checks for explicit presence of the return_type field.
    
    Returns:
    
    True if return_type has been set.
  - hasReturnType
```
public boolean hasReturnType()
```
    Checks for presence of the return_type field.
    
    Specified by:
    
    hasReturnType in interface FunctionType_OrBuilder
    
    Returns:
    
    True if return_type is present.
  - isModifiedReturnType
```
public boolean isModifiedReturnType()
```
    Checks if the return_type field has been modified since the builder was created.
    
    Returns:
    
    True if return_type has been modified.
  - clearReturnType
```
@Nonnull
public FunctionType._Builder clearReturnType()
```
    Clear the return_type field.
    
    Returns:
    
    The builder
  - getReturnType
```
public String getReturnType()
```
    Specified by:
    
    getReturnType in interface FunctionType_OrBuilder
    
    Returns:
    
    The return_type field value
  - optionalReturnType
```
@Nonnull
public Optional<String> optionalReturnType()
```
    Specified by:
    
    optionalReturnType in interface FunctionType_OrBuilder
    
    Returns:
    
    Optional return_type field value
  - setName
```
@Nonnull
public FunctionType._Builder setName(String value)
```
    Set the name field value.
    
    Specified by:
    
    setName in interface Decl._Builder
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - isSetName
```
public boolean isSetName()
```
    Checks for explicit presence of the name field.
    
    Returns:
    
    True if name has been set.
  - hasName
```
public boolean hasName()
```
    Checks for presence of the name field.
    
    Specified by:
    
    hasName in interface Decl
    
    Returns:
    
    True if name is present.
  - 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 FunctionType._Builder clearName()
```
    Clear the name field.
    
    Specified by:
    
    clearName in interface Decl._Builder
    
    Returns:
    
    The builder
  - getName
```
public String getName()
```
    Description copied from interface: Decl
    
    Name of the type, constant or service.
    
    Specified by:
    
    getName in interface Decl
    
    Returns:
    
    The name field value
  - setParams
```
@Nonnull
public FunctionType._Builder setParams(Collection<FieldType> value)
```
    Set the params field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - addToParams
```
@Nonnull
public FunctionType._Builder addToParams(FieldType... values)
```
    Adds entries to the params list.
    
    Parameters:
    
    values - The added value
    
    Returns:
    
    The builder
  - isSetParams
```
public boolean isSetParams()
```
    Checks for explicit presence of the params field.
    
    Returns:
    
    True if params has been set.
  - hasParams
```
public boolean hasParams()
```
    Checks for presence of the params field.
    
    Specified by:
    
    hasParams in interface FunctionType_OrBuilder
    
    Returns:
    
    True if params is present.
  - isModifiedParams
```
public boolean isModifiedParams()
```
    Checks if the params field has been modified since the builder was created.
    
    Returns:
    
    True if params has been modified.
  - clearParams
```
@Nonnull
public FunctionType._Builder clearParams()
```
    Clear the params field.
    
    Returns:
    
    The builder
  - mutableParams
```
public List<FieldType> mutableParams()
```
    Returns:
    
    The mutable params container
  - getParams
```
public List<FieldType> getParams()
```
    Specified by:
    
    getParams in interface FunctionType_OrBuilder
    
    Returns:
    
    The params field value
  - numParams
```
public int numParams()
```
    Specified by:
    
    numParams in interface FunctionType_OrBuilder
    
    Returns:
    
    Number of entries in params.
  - setExceptions
```
@Nonnull
public FunctionType._Builder setExceptions(Collection<FieldType> value)
```
    Set the exceptions field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - addToExceptions
```
@Nonnull
public FunctionType._Builder addToExceptions(FieldType... values)
```
    Adds entries to the exceptions list.
    
    Parameters:
    
    values - The added value
    
    Returns:
    
    The builder
  - isSetExceptions
```
public boolean isSetExceptions()
```
    Checks for explicit presence of the exceptions field.
    
    Returns:
    
    True if exceptions has been set.
  - hasExceptions
```
public boolean hasExceptions()
```
    Checks for presence of the exceptions field.
    
    Specified by:
    
    hasExceptions in interface FunctionType_OrBuilder
    
    Returns:
    
    True if exceptions is present.
  - isModifiedExceptions
```
public boolean isModifiedExceptions()
```
    Checks if the exceptions field has been modified since the builder was created.
    
    Returns:
    
    True if exceptions has been modified.
  - clearExceptions
```
@Nonnull
public FunctionType._Builder clearExceptions()
```
    Clear the exceptions field.
    
    Returns:
    
    The builder
  - mutableExceptions
```
public List<FieldType> mutableExceptions()
```
    Returns:
    
    The mutable exceptions container
  - getExceptions
```
public List<FieldType> getExceptions()
```
    Specified by:
    
    getExceptions in interface FunctionType_OrBuilder
    
    Returns:
    
    The exceptions field value
  - optionalExceptions
```
@Nonnull
public Optional<List<FieldType>> optionalExceptions()
```
    Specified by:
    
    optionalExceptions in interface FunctionType_OrBuilder
    
    Returns:
    
    Optional exceptions field value
  - numExceptions
```
public int numExceptions()
```
    Specified by:
    
    numExceptions in interface FunctionType_OrBuilder
    
    Returns:
    
    Number of entries in exceptions.
  - setAnnotations
```
@Nonnull
public FunctionType._Builder setAnnotations(Map<String,String> value)
```
    Set the annotations field value.
    
    Parameters:
    
    value - The new value
    
    Returns:
    
    The builder
  - putInAnnotations
```
@Nonnull
public FunctionType._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 explicit presence of the annotations field.
    
    Returns:
    
    True if annotations has been set.
  - hasAnnotations
```
public boolean hasAnnotations()
```
    Checks for presence of the annotations field.
    
    Specified by:
    
    hasAnnotations in interface FunctionType_OrBuilder
    
    Returns:
    
    True if annotations is present.
  - 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 FunctionType._Builder clearAnnotations()
```
    Clear the annotations field.
    
    Returns:
    
    The builder
  - mutableAnnotations
```
public Map<String,String> mutableAnnotations()
```
    Returns:
    
    The mutable annotations container
  - getAnnotations
```
public Map<String,String> getAnnotations()
```
    Specified by:
    
    getAnnotations in interface FunctionType_OrBuilder
    
    Returns:
    
    The annotations field value
  - optionalAnnotations
```
@Nonnull
public Optional<Map<String,String>> optionalAnnotations()
```
    Specified by:
    
    optionalAnnotations in interface FunctionType_OrBuilder
    
    Returns:
    
    Optional annotations field value
  - numAnnotations
```
public int numAnnotations()
```
    Specified by:
    
    numAnnotations in interface FunctionType_OrBuilder
    
    Returns:
    
    Number of entries in annotations.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - mutator
```
public net.morimekta.providence.PMessageBuilder mutator(int key)
```
    Specified by:
    
    mutator in class net.morimekta.providence.PMessageBuilder<FunctionType>
  - set
```
@Nonnull
public FunctionType._Builder set(int key,
                                          Object value)
```
    Specified by:
    
    set in class net.morimekta.providence.PMessageBuilder<FunctionType>
  - isSet
```
public boolean isSet(int key)
```
    Specified by:
    
    isSet in class net.morimekta.providence.PMessageBuilder<FunctionType>
  - isModified
```
public boolean isModified(int key)
```
    Specified by:
    
    isModified in class net.morimekta.providence.PMessageBuilder<FunctionType>
  - get
```
public <T> T get(int key)
```
    Specified by:
    
    get in interface net.morimekta.providence.PMessageOrBuilder<FunctionType>
  - has
```
public boolean has(int key)
```
    Specified by:
    
    has in interface net.morimekta.providence.PMessageOrBuilder<FunctionType>
  - addTo
```
@Nonnull
public FunctionType._Builder addTo(int key,
                                            Object value)
```
    Specified by:
    
    addTo in class net.morimekta.providence.PMessageBuilder<FunctionType>
  - clear
```
@Nonnull
public FunctionType._Builder clear(int key)
```
    Specified by:
    
    clear in class net.morimekta.providence.PMessageBuilder<FunctionType>
  - valid
```
public boolean valid()
```
    Specified by:
    
    valid in class net.morimekta.providence.PMessageBuilder<FunctionType>
  - validate
```
public FunctionType._Builder validate()
```
    Specified by:
    
    validate in class net.morimekta.providence.PMessageBuilder<FunctionType>
  - descriptor
```
@Nonnull
public net.morimekta.providence.descriptor.PStructDescriptor<FunctionType> descriptor()
```
    Specified by:
    
    descriptor in interface net.morimekta.providence.PMessageOrBuilder<FunctionType>
    
    Specified by:
    
    descriptor in interface net.morimekta.providence.PValue<FunctionType>
  - readBinary
```
public void readBinary(net.morimekta.util.io.BigEndianBinaryReader reader,
                       boolean strict)
                throws IOException
```
    Specified by:
    
    readBinary in interface net.morimekta.providence.serializer.binary.BinaryReader
    
    Throws:
    
    IOException
  - build
```
@Nonnull
public FunctionType build()
```
    Specified by:
    
    build in interface Decl._Builder
    
    Specified by:
    
    build in class net.morimekta.providence.PMessageBuilder<FunctionType>
    
    Returns:
    
    The built instance

Class FunctionType._Builder

Nested Class Summary

Nested classes/interfaces inherited from interface net.morimekta.providence.model.Decl

Field Summary

Fields inherited from interface net.morimekta.providence.model.Decl

Constructor Summary

Method Summary

Methods inherited from class net.morimekta.providence.PMessageBuilder

Methods inherited from class java.lang.Object

Methods inherited from interface net.morimekta.providence.PMessageOrBuilder

Constructor Detail

_Builder

_Builder

Method Detail

merge

setDocumentation

isSetDocumentation

hasDocumentation

isModifiedDocumentation

clearDocumentation

getDocumentation

optionalDocumentation

setOneWay

setOneWay

isSetOneWay

hasOneWay

isModifiedOneWay

clearOneWay

isOneWay

optionalOneWay

setReturnType

isSetReturnType

hasReturnType

isModifiedReturnType

clearReturnType

getReturnType

optionalReturnType

setName

isSetName

hasName

isModifiedName

clearName

getName

setParams

addToParams

isSetParams

hasParams

isModifiedParams

clearParams

mutableParams

getParams

numParams

setExceptions

addToExceptions

isSetExceptions

hasExceptions

isModifiedExceptions

clearExceptions

mutableExceptions

getExceptions

optionalExceptions

numExceptions

setAnnotations

putInAnnotations

isSetAnnotations

hasAnnotations

isModifiedAnnotations

clearAnnotations

mutableAnnotations

getAnnotations

optionalAnnotations

numAnnotations

equals

hashCode

mutator

set

isSet

isModified

get

has