MessageType (Providence Generator : Common 2.6.1 API)

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

All Implemented Interfaces:

Serializable, Comparable<MessageType>, Decl, MessageType_OrBuilder, net.morimekta.providence.PMessage<MessageType>, net.morimekta.providence.PMessageOrBuilder<MessageType>, net.morimekta.providence.PValue<MessageType>, net.morimekta.providence.serializer.binary.BinaryWriter, net.morimekta.util.Stringable
```
@Generated(value="net.morimekta.providence:providence-generator-java",
           comments="java:serializable")
 @Immutable
public class MessageType
extends Object
implements Decl, MessageType_OrBuilder, net.morimekta.providence.PMessage<MessageType>, Comparable<MessageType>, Serializable, net.morimekta.providence.serializer.binary.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 net.morimekta.providence.descriptor.PStructDescriptor<MessageType> kDescriptor

Fields
Modifier and Type	Field and Description
`static net.morimekta.providence.descriptor.PStructDescriptor<MessageType>`	`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 `p_model.MessageType` builder.
`int`	`compareTo(MessageType other)`
`net.morimekta.providence.descriptor.PStructDescriptor<MessageType>`	`descriptor()`
`boolean`	`equals(Object o)`
`<T> T`	`get(int key)`
`Map<String,String>`	`getAnnotations()`
`String`	`getDocumentation()` Documentation for the specific declaration.
`List<FieldType>`	`getFields()`
`String`	`getImplementing()` Interface this message is implementing.
`String`	`getName()` Name of the type, constant or service.
`MessageVariant`	`getVariant()`
`boolean`	`has(int key)`
`boolean`	`hasAnnotations()`
`boolean`	`hasDocumentation()`
`boolean`	`hasFields()`
`int`	`hashCode()`
`boolean`	`hasImplementing()`
`boolean`	`hasName()`
`boolean`	`hasVariant()`
`MessageType._Builder`	`mutate()`
`int`	`numAnnotations()`
`int`	`numFields()`
`Optional<Map<String,String>>`	`optionalAnnotations()`
`Optional<String>`	`optionalDocumentation()` Documentation for the specific declaration.
`Optional<String>`	`optionalImplementing()` Interface this message is implementing.
`Optional<MessageVariant>`	`optionalVariant()`
`static net.morimekta.providence.descriptor.PStructDescriptorProvider<MessageType>`	`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<MessageType> 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.
  - hasVariant
```
public boolean hasVariant()
```
    Specified by:
    
    hasVariant in interface MessageType_OrBuilder
    
    Returns:
    
    If variant is present.
  - getVariant
```
public MessageVariant getVariant()
```
    Specified by:
    
    getVariant in interface MessageType_OrBuilder
    
    Returns:
    
    The variant value
  - optionalVariant
```
@Nonnull
public Optional<MessageVariant> optionalVariant()
```
    Specified by:
    
    optionalVariant in interface MessageType_OrBuilder
    
    Returns:
    
    Optional of the variant 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
  - numFields
```
public int numFields()
```
    Specified by:
    
    numFields in interface MessageType_OrBuilder
    
    Returns:
    
    Number of entries in fields.
  - hasFields
```
public boolean hasFields()
```
    Specified by:
    
    hasFields in interface MessageType_OrBuilder
    
    Returns:
    
    If fields is present.
  - getFields
```
@Nonnull
public List<FieldType> getFields()
```
    Specified by:
    
    getFields in interface MessageType_OrBuilder
    
    Returns:
    
    The fields value
  - numAnnotations
```
public int numAnnotations()
```
    Specified by:
    
    numAnnotations in interface MessageType_OrBuilder
    
    Returns:
    
    Number of entries in annotations.
  - hasAnnotations
```
public boolean hasAnnotations()
```
    Specified by:
    
    hasAnnotations in interface MessageType_OrBuilder
    
    Returns:
    
    If annotations is present.
  - getAnnotations
```
public Map<String,String> getAnnotations()
```
    Specified by:
    
    getAnnotations in interface MessageType_OrBuilder
    
    Returns:
    
    The annotations value
  - optionalAnnotations
```
@Nonnull
public Optional<Map<String,String>> optionalAnnotations()
```
    Specified by:
    
    optionalAnnotations in interface MessageType_OrBuilder
    
    Returns:
    
    Optional of the annotations field value.
  - hasImplementing
```
public boolean hasImplementing()
```
    Specified by:
    
    hasImplementing in interface MessageType_OrBuilder
    
    Returns:
    
    If implementing is present.
  - getImplementing
```
public String getImplementing()
```
    Interface this message is implementing.
    
    Specified by:
    
    getImplementing in interface MessageType_OrBuilder
    
    Returns:
    
    The implementing value
  - optionalImplementing
```
@Nonnull
public Optional<String> optionalImplementing()
```
    Interface this message is implementing.
    
    Specified by:
    
    optionalImplementing in interface MessageType_OrBuilder
    
    Returns:
    
    Optional of the implementing field value.
  - has
```
public boolean has(int key)
```
    Specified by:
    
    has in interface net.morimekta.providence.PMessageOrBuilder<MessageType>
  - get
```
public <T> T get(int key)
```
    Specified by:
    
    get in interface net.morimekta.providence.PMessageOrBuilder<MessageType>
  - 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<MessageType>
    
    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 net.morimekta.providence.serializer.binary.BinaryWriter
    
    Throws:
    
    IOException
  - mutate
```
@Nonnull
public MessageType._Builder mutate()
```
    Specified by:
    
    mutate in interface net.morimekta.providence.PMessage<MessageType>
  - provider
```
@Nonnull
public static net.morimekta.providence.descriptor.PStructDescriptorProvider<MessageType> provider()
```
  - descriptor
```
@Nonnull
public net.morimekta.providence.descriptor.PStructDescriptor<MessageType> descriptor()
```
    Specified by:
    
    descriptor in interface net.morimekta.providence.PMessageOrBuilder<MessageType>
    
    Specified by:
    
    descriptor in interface net.morimekta.providence.PValue<MessageType>
  - builder
```
public static MessageType._Builder builder()
```
    Make a p_model.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

Methods inherited from interface net.morimekta.providence.PMessageOrBuilder

Field Detail

kDescriptor

Method Detail

hasDocumentation

getDocumentation

optionalDocumentation

hasVariant

getVariant

optionalVariant

hasName

getName

numFields

hasFields

getFields

numAnnotations

hasAnnotations

getAnnotations

optionalAnnotations

hasImplementing

getImplementing

optionalImplementing

has

get

equals

hashCode

toString

asString

compareTo

writeBinary

mutate

provider

descriptor

builder