net.morimekta.providence.model

Class MessageType

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
String	asString()
static MessageType._Builder	builder() Make a model.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()
List<FieldType>	getFields()
String	getName()
MessageVariant	getVariant()
boolean	has(int key)
boolean	hasAnnotations()
boolean	hasDocumentation()
boolean	hasFields()
int	hashCode()
boolean	hasName()
boolean	hasVariant()
MessageType._Builder	mutate()
int	numAnnotations()
int	numFields()
Optional<Map<String,String>>	optionalAnnotations()
Optional<String>	optionalDocumentation()
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 field value

optionalDocumentation

@Nonnull
public Optional<String> optionalDocumentation()

Returns:

Optional field value

hasVariant

public boolean hasVariant()

getVariant

public MessageVariant getVariant()

Returns:

The field value

optionalVariant

@Nonnull
public Optional<MessageVariant> optionalVariant()

Returns:

Optional field value

hasName

public boolean hasName()

getName

@Nonnull
public String getName()

Returns:

The field value

numFields

public int numFields()

hasFields

public boolean hasFields()

getFields

@Nonnull
public List<FieldType> getFields()

Returns:

The field value

numAnnotations

public int numAnnotations()

hasAnnotations

public boolean hasAnnotations()

getAnnotations

public Map<String,String> getAnnotations()

Returns:

The field value

optionalAnnotations

@Nonnull
public Optional<Map<String,String>> optionalAnnotations()

Returns:

Optional 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 model.MessageType builder.

Returns:

The builder instance.