FunctionType (Providence Utils : Reflection 1.8.0 API)

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

All Implemented Interfaces:

Serializable, Comparable<FunctionType>, PMessage<FunctionType,FunctionType._Field>, PValue<FunctionType>, BinaryWriter, net.morimekta.util.Stringable
```
@Generated(value="providence-maven-plugin")
 @Immutable
public class FunctionType
extends Object
implements PMessage<FunctionType,FunctionType._Field>, Comparable<FunctionType>, Serializable, 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 PStructDescriptor<FunctionType,FunctionType._Field> kDescriptor

Fields
Modifier and Type	Field and Description
`static PStructDescriptor<FunctionType,FunctionType._Field>`	`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 `pmodel.FunctionType` builder.
`int`	`compareTo(FunctionType other)`
`PStructDescriptor<FunctionType,FunctionType._Field>`	`descriptor()`
`boolean`	`equals(Object o)`
`<T> T`	`get(int key)`
`Map<String,String>`	`getAnnotations()`
`String`	`getDocumentation()`
`FilePos`	`getEndPos()` The end of the definition
`List<FieldType>`	`getExceptions()`
`String`	`getName()`
`List<FieldType>`	`getParams()`
`String`	`getReturnType()`
`FilePos`	`getStartPos()` The start of the definition (position of return type)
`boolean`	`has(int key)`
`boolean`	`hasAnnotations()`
`boolean`	`hasDocumentation()`
`boolean`	`hasEndPos()`
`boolean`	`hasExceptions()`
`int`	`hashCode()`
`boolean`	`hasName()`
`boolean`	`hasOneWay()`
`boolean`	`hasParams()`
`boolean`	`hasReturnType()`
`boolean`	`hasStartPos()`
`boolean`	`isOneWay()`
`FunctionType._Builder`	`mutate()`
`int`	`numAnnotations()`
`int`	`numExceptions()`
`int`	`numParams()`
`Optional<Map<String,String>>`	`optionalAnnotations()`
`Optional<String>`	`optionalDocumentation()`
`Optional<FilePos>`	`optionalEndPos()` The end of the definition
`Optional<List<FieldType>>`	`optionalExceptions()`
`Optional<Boolean>`	`optionalOneWay()`
`Optional<String>`	`optionalReturnType()`
`Optional<FilePos>`	`optionalStartPos()` The start of the definition (position of return type)
`static PStructDescriptorProvider<FunctionType,FunctionType._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<FunctionType,FunctionType._Field> kDescriptor
```
- Method Detail
  - hasDocumentation
```
public boolean hasDocumentation()
```
  - getDocumentation
```
public String getDocumentation()
```
    Returns:
    
    The documentation value
  - optionalDocumentation
```
@Nonnull
public Optional<String> optionalDocumentation()
```
    Returns:
    
    Optional of the documentation field value.
  - hasOneWay
```
public boolean hasOneWay()
```
  - isOneWay
```
public boolean isOneWay()
```
    Returns:
    
    The one_way value
  - optionalOneWay
```
@Nonnull
public Optional<Boolean> optionalOneWay()
```
    Returns:
    
    Optional of the one_way field value.
  - hasReturnType
```
public boolean hasReturnType()
```
  - getReturnType
```
public String getReturnType()
```
    Returns:
    
    The return_type value
  - optionalReturnType
```
@Nonnull
public Optional<String> optionalReturnType()
```
    Returns:
    
    Optional of the return_type field value.
  - hasName
```
public boolean hasName()
```
  - getName
```
@Nonnull
public String getName()
```
    Returns:
    
    The name value
  - numParams
```
public int numParams()
```
  - hasParams
```
public boolean hasParams()
```
  - getParams
```
@Nonnull
public List<FieldType> getParams()
```
    Returns:
    
    The params value
  - numExceptions
```
public int numExceptions()
```
  - hasExceptions
```
public boolean hasExceptions()
```
  - getExceptions
```
public List<FieldType> getExceptions()
```
    Returns:
    
    The exceptions value
  - optionalExceptions
```
@Nonnull
public Optional<List<FieldType>> optionalExceptions()
```
    Returns:
    
    Optional of the exceptions field value.
  - numAnnotations
```
public int numAnnotations()
```
  - hasAnnotations
```
public boolean hasAnnotations()
```
  - getAnnotations
```
public Map<String,String> getAnnotations()
```
    Returns:
    
    The annotations value
  - optionalAnnotations
```
@Nonnull
public Optional<Map<String,String>> optionalAnnotations()
```
    Returns:
    
    Optional of the annotations field value.
  - hasStartPos
```
public boolean hasStartPos()
```
  - getStartPos
```
public FilePos getStartPos()
```
    The start of the definition (position of return type)
    
    Returns:
    
    The start_pos value
  - optionalStartPos
```
@Nonnull
public Optional<FilePos> optionalStartPos()
```
    The start of the definition (position of return type)
    
    Returns:
    
    Optional of the start_pos field value.
  - hasEndPos
```
public boolean hasEndPos()
```
  - getEndPos
```
public FilePos getEndPos()
```
    The end of the definition
    
    Returns:
    
    The end_pos value
  - optionalEndPos
```
@Nonnull
public Optional<FilePos> optionalEndPos()
```
    The end of the definition
    
    Returns:
    
    Optional of the end_pos field value.
  - has
```
public boolean has(int key)
```
    Specified by:
    
    has in interface PMessage<FunctionType,FunctionType._Field>
  - get
```
public <T> T get(int key)
```
    Specified by:
    
    get in interface PMessage<FunctionType,FunctionType._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<FunctionType,FunctionType._Field>
    
    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 BinaryWriter
    
    Throws:
    
    IOException
  - mutate
```
@Nonnull
public FunctionType._Builder mutate()
```
    Specified by:
    
    mutate in interface PMessage<FunctionType,FunctionType._Field>
  - provider
```
@Nonnull
public static PStructDescriptorProvider<FunctionType,FunctionType._Field> provider()
```
  - descriptor
```
@Nonnull
public PStructDescriptor<FunctionType,FunctionType._Field> descriptor()
```
    Specified by:
    
    descriptor in interface PMessage<FunctionType,FunctionType._Field>
    
    Specified by:
    
    descriptor in interface PValue<FunctionType>
  - builder
```
public static FunctionType._Builder builder()
```
    Make a pmodel.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

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

hasStartPos

getStartPos

optionalStartPos

hasEndPos

getEndPos

optionalEndPos

has

get

equals

hashCode

toString

asString

compareTo

writeBinary

mutate

provider

descriptor

builder