MessageType (Providence Utils : Reflection 1.8.0 API)

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

All Implemented Interfaces:

Serializable, Comparable<MessageType>, PMessage<MessageType,MessageType._Field>, PValue<MessageType>, BinaryWriter, net.morimekta.util.Stringable
```
@Generated(value="providence-maven-plugin")
 @Immutable
public class MessageType
extends Object
implements PMessage<MessageType,MessageType._Field>, Comparable<MessageType>, Serializable, BinaryWriter
```
<variant> { (<field> ([,;])?)* }

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MessageType._Builder
<variant> { (<field> ([,;])?)

static class MessageType._Field

Nested Classes
Modifier and Type	Class and Description
`static class`	`MessageType._Builder` <variant> { (<field> ([,;])?)
`static class`	`MessageType._Field`

Field Summary

Fields
Modifier and Type Field and Description

static PStructDescriptor<MessageType,MessageType._Field> kDescriptor

Fields
Modifier and Type	Field and Description
`static PStructDescriptor<MessageType,MessageType._Field>`	`kDescriptor`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`asString()`
`static MessageType._Builder`	`builder()` Make a `pmodel.MessageType` builder.
`int`	`compareTo(MessageType other)`
`PStructDescriptor<MessageType,MessageType._Field>`	`descriptor()`
`boolean`	`equals(Object o)`
`<T> T`	`get(int key)`
`Map<String,String>`	`getAnnotations()`
`String`	`getDocumentation()`
`FilePos`	`getEndPos()` The end of the definition (position of '}')
`List<FieldType>`	`getFields()`
`String`	`getName()`
`FilePos`	`getStartPos()` The start of the definition (position of 'struct' / message type)
`MessageVariant`	`getVariant()`
`boolean`	`has(int key)`
`boolean`	`hasAnnotations()`
`boolean`	`hasDocumentation()`
`boolean`	`hasEndPos()`
`boolean`	`hasFields()`
`int`	`hashCode()`
`boolean`	`hasName()`
`boolean`	`hasStartPos()`
`boolean`	`hasVariant()`
`MessageType._Builder`	`mutate()`
`int`	`numAnnotations()`
`int`	`numFields()`
`Optional<Map<String,String>>`	`optionalAnnotations()`
`Optional<String>`	`optionalDocumentation()`
`Optional<FilePos>`	`optionalEndPos()` The end of the definition (position of '}')
`Optional<FilePos>`	`optionalStartPos()` The start of the definition (position of 'struct' / message type)
`Optional<MessageVariant>`	`optionalVariant()`
`static PStructDescriptorProvider<MessageType,MessageType._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<MessageType,MessageType._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.
  - hasVariant
```
public boolean hasVariant()
```
  - getVariant
```
public MessageVariant getVariant()
```
    Returns:
    
    The variant value
  - optionalVariant
```
@Nonnull
public Optional<MessageVariant> optionalVariant()
```
    Returns:
    
    Optional of the variant field value.
  - hasName
```
public boolean hasName()
```
  - getName
```
@Nonnull
public String getName()
```
    Returns:
    
    The name value
  - numFields
```
public int numFields()
```
  - hasFields
```
public boolean hasFields()
```
  - getFields
```
@Nonnull
public List<FieldType> getFields()
```
    Returns:
    
    The fields 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 'struct' / message type)
    
    Returns:
    
    The start_pos value
  - optionalStartPos
```
@Nonnull
public Optional<FilePos> optionalStartPos()
```
    The start of the definition (position of 'struct' / message type)
    
    Returns:
    
    Optional of the start_pos field value.
  - hasEndPos
```
public boolean hasEndPos()
```
  - getEndPos
```
public FilePos getEndPos()
```
    The end of the definition (position of '}')
    
    Returns:
    
    The end_pos value
  - optionalEndPos
```
@Nonnull
public Optional<FilePos> optionalEndPos()
```
    The end of the definition (position of '}')
    
    Returns:
    
    Optional of the end_pos field value.
  - has
```
public boolean has(int key)
```
    Specified by:
    
    has in interface PMessage<MessageType,MessageType._Field>
  - get
```
public <T> T get(int key)
```
    Specified by:
    
    get in interface PMessage<MessageType,MessageType._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<MessageType,MessageType._Field>
    
    Specified by:
    
    asString in interface net.morimekta.util.Stringable
  - compareTo
```
public int compareTo(MessageType other)
```
    Specified by:
    
    compareTo in interface Comparable<MessageType>
  - writeBinary
```
public int writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer)
                throws IOException
```
    Specified by:
    
    writeBinary in interface BinaryWriter
    
    Throws:
    
    IOException
  - mutate
```
@Nonnull
public MessageType._Builder mutate()
```
    Specified by:
    
    mutate in interface PMessage<MessageType,MessageType._Field>
  - provider
```
@Nonnull
public static PStructDescriptorProvider<MessageType,MessageType._Field> provider()
```
  - descriptor
```
@Nonnull
public PStructDescriptor<MessageType,MessageType._Field> descriptor()
```
    Specified by:
    
    descriptor in interface PMessage<MessageType,MessageType._Field>
    
    Specified by:
    
    descriptor in interface PValue<MessageType>
  - builder
```
public static MessageType._Builder builder()
```
    Make a pmodel.MessageType builder.
    
    Returns:
    
    The builder instance.

Class MessageType

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

hasVariant

getVariant

optionalVariant

hasName

getName

numFields

hasFields

getFields

numAnnotations

hasAnnotations

getAnnotations

optionalAnnotations

hasStartPos

getStartPos

optionalStartPos

hasEndPos

getEndPos

optionalEndPos

has

get

equals

hashCode

toString

asString

compareTo

writeBinary

mutate

provider

descriptor

builder