FunctionType (Providence Generator : Common 2.6.0 API)

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

All Implemented Interfaces:

Serializable, Comparable<FunctionType>, Decl, FunctionType_OrBuilder, net.morimekta.providence.PMessage<FunctionType>, net.morimekta.providence.PMessageOrBuilder<FunctionType>, net.morimekta.providence.PValue<FunctionType>, net.morimekta.providence.serializer.binary.BinaryWriter, net.morimekta.util.Stringable
```
@Generated(value="net.morimekta.providence:providence-generator-java",
           comments="java:serializable")
 @Immutable
public class FunctionType
extends Object
implements Decl, FunctionType_OrBuilder, net.morimekta.providence.PMessage<FunctionType>, Comparable<FunctionType>, Serializable, net.morimekta.providence.serializer.binary.BinaryWriter
```
(oneway)? <return_type> <name>'('<param>*')' (throws '(' <exception>+ ')')?

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FunctionType._Builder
(oneway)?

static class FunctionType._Field

Nested Classes
Modifier and Type	Class and Description
`static class`	`FunctionType._Builder` (oneway)?
`static class`	`FunctionType._Field`

Field Summary

Fields
Modifier and Type Field and Description

static net.morimekta.providence.descriptor.PStructDescriptor<FunctionType> kDescriptor

Fields
Modifier and Type	Field and Description
`static net.morimekta.providence.descriptor.PStructDescriptor<FunctionType>`	`kDescriptor`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`asString()`
`static FunctionType._Builder`	`builder()` Make a `p_model.FunctionType` builder.
`int`	`compareTo(FunctionType other)`
`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()`
`boolean`	`hasDocumentation()`
`boolean`	`hasExceptions()`
`int`	`hashCode()`
`boolean`	`hasName()`
`boolean`	`hasOneWay()`
`boolean`	`hasParams()`
`boolean`	`hasReturnType()`
`boolean`	`isOneWay()`
`FunctionType._Builder`	`mutate()`
`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()`
`static net.morimekta.providence.descriptor.PStructDescriptorProvider<FunctionType>`	`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

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

- Field Detail
  - kDescriptor
```
public static final net.morimekta.providence.descriptor.PStructDescriptor<FunctionType> kDescriptor
```
- Method Detail
  - hasDocumentation
```
public boolean hasDocumentation()
```
    Specified by:
    
    hasDocumentation in interface Decl
    
    Returns:
    
    If documentation is present.
  - getDocumentation
```
public String getDocumentation()
```
    Description copied from interface: Decl
    
    Documentation for the specific declaration.
    
    Specified by:
    
    getDocumentation in interface Decl
    
    Returns:
    
    The documentation 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 of the documentation field value.
  - hasOneWay
```
public boolean hasOneWay()
```
    Specified by:
    
    hasOneWay in interface FunctionType_OrBuilder
    
    Returns:
    
    If one_way is present.
  - isOneWay
```
public boolean isOneWay()
```
    Specified by:
    
    isOneWay in interface FunctionType_OrBuilder
    
    Returns:
    
    The one_way value
  - optionalOneWay
```
@Nonnull
public Optional<Boolean> optionalOneWay()
```
    Specified by:
    
    optionalOneWay in interface FunctionType_OrBuilder
    
    Returns:
    
    Optional of the one_way field value.
  - hasReturnType
```
public boolean hasReturnType()
```
    Specified by:
    
    hasReturnType in interface FunctionType_OrBuilder
    
    Returns:
    
    If return_type is present.
  - getReturnType
```
public String getReturnType()
```
    Specified by:
    
    getReturnType in interface FunctionType_OrBuilder
    
    Returns:
    
    The return_type value
  - optionalReturnType
```
@Nonnull
public Optional<String> optionalReturnType()
```
    Specified by:
    
    optionalReturnType in interface FunctionType_OrBuilder
    
    Returns:
    
    Optional of the return_type field value.
  - hasName
```
public boolean hasName()
```
    Specified by:
    
    hasName in interface Decl
    
    Returns:
    
    If name is present.
  - getName
```
@Nonnull
public String getName()
```
    Description copied from interface: Decl
    
    Name of the type, constant or service.
    
    Specified by:
    
    getName in interface Decl
    
    Returns:
    
    The name value
  - numParams
```
public int numParams()
```
    Specified by:
    
    numParams in interface FunctionType_OrBuilder
    
    Returns:
    
    Number of entries in params.
  - hasParams
```
public boolean hasParams()
```
    Specified by:
    
    hasParams in interface FunctionType_OrBuilder
    
    Returns:
    
    If params is present.
  - getParams
```
@Nonnull
public List<FieldType> getParams()
```
    Specified by:
    
    getParams in interface FunctionType_OrBuilder
    
    Returns:
    
    The params value
  - numExceptions
```
public int numExceptions()
```
    Specified by:
    
    numExceptions in interface FunctionType_OrBuilder
    
    Returns:
    
    Number of entries in exceptions.
  - hasExceptions
```
public boolean hasExceptions()
```
    Specified by:
    
    hasExceptions in interface FunctionType_OrBuilder
    
    Returns:
    
    If exceptions is present.
  - getExceptions
```
public List<FieldType> getExceptions()
```
    Specified by:
    
    getExceptions in interface FunctionType_OrBuilder
    
    Returns:
    
    The exceptions value
  - optionalExceptions
```
@Nonnull
public Optional<List<FieldType>> optionalExceptions()
```
    Specified by:
    
    optionalExceptions in interface FunctionType_OrBuilder
    
    Returns:
    
    Optional of the exceptions field value.
  - numAnnotations
```
public int numAnnotations()
```
    Specified by:
    
    numAnnotations in interface FunctionType_OrBuilder
    
    Returns:
    
    Number of entries in annotations.
  - hasAnnotations
```
public boolean hasAnnotations()
```
    Specified by:
    
    hasAnnotations in interface FunctionType_OrBuilder
    
    Returns:
    
    If annotations is present.
  - getAnnotations
```
public Map<String,String> getAnnotations()
```
    Specified by:
    
    getAnnotations in interface FunctionType_OrBuilder
    
    Returns:
    
    The annotations value
  - optionalAnnotations
```
@Nonnull
public Optional<Map<String,String>> optionalAnnotations()
```
    Specified by:
    
    optionalAnnotations in interface FunctionType_OrBuilder
    
    Returns:
    
    Optional of the annotations field value.
  - has
```
public boolean has(int key)
```
    Specified by:
    
    has in interface net.morimekta.providence.PMessageOrBuilder<FunctionType>
  - get
```
public <T> T get(int key)
```
    Specified by:
    
    get in interface net.morimekta.providence.PMessageOrBuilder<FunctionType>
  - 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 net.morimekta.providence.PMessage<FunctionType>
    
    Specified by:
    
    asString in interface net.morimekta.util.Stringable
  - compareTo
```
public int compareTo(FunctionType other)
```
    Specified by:
    
    compareTo in interface Comparable<FunctionType>
  - writeBinary
```
public int writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer)
                throws IOException
```
    Specified by:
    
    writeBinary in interface net.morimekta.providence.serializer.binary.BinaryWriter
    
    Throws:
    
    IOException
  - mutate
```
@Nonnull
public FunctionType._Builder mutate()
```
    Specified by:
    
    mutate in interface net.morimekta.providence.PMessage<FunctionType>
  - provider
```
@Nonnull
public static net.morimekta.providence.descriptor.PStructDescriptorProvider<FunctionType> provider()
```
  - 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>
  - builder
```
public static FunctionType._Builder builder()
```
    Make a p_model.FunctionType builder.
    
    Returns:
    
    The builder instance.

Class FunctionType

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.morimekta.providence.PMessage

Methods inherited from interface net.morimekta.providence.PMessageOrBuilder

Field Detail

kDescriptor

Method Detail

hasDocumentation

getDocumentation

optionalDocumentation

hasOneWay

isOneWay

optionalOneWay

hasReturnType

getReturnType

optionalReturnType

hasName

getName

numParams

hasParams

getParams

numExceptions

hasExceptions

getExceptions

optionalExceptions

numAnnotations

hasAnnotations

getAnnotations

optionalAnnotations

has

get

equals

hashCode

toString

asString

compareTo

writeBinary

mutate

provider

descriptor

builder