Package net.morimekta.providence.model
Class MessageType
- java.lang.Object
-
- net.morimekta.providence.model.MessageType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<MessageType>
,Decl
,MessageType_OrBuilder
,PMessage<MessageType>
,PMessageOrBuilder<MessageType>
,PValue<MessageType>
,BinaryWriter
,net.morimekta.util.Stringable
@Generated(value="net.morimekta.providence:providence-generator-java", comments="java:serializable") @Immutable public class MessageType extends java.lang.Object implements Decl, MessageType_OrBuilder, PMessage<MessageType>, java.lang.Comparable<MessageType>, java.io.Serializable, BinaryWriter
<variant> { (<field> ([,;])?)* }- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MessageType._Builder
<variant> { (<field> ([,;])?)static class
MessageType._Field
-
Field Summary
Fields Modifier and Type Field Description static PStructDescriptor<MessageType>
kDescriptor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
asString()
Pure string representation of content.static MessageType._Builder
builder()
Make ap_model.MessageType
builder.int
compareTo(MessageType other)
PStructDescriptor<MessageType>
descriptor()
boolean
equals(java.lang.Object o)
<T> T
get(int key)
java.util.Map<java.lang.String,java.lang.String>
getAnnotations()
java.lang.String
getDocumentation()
Documentation for the specific declaration.java.util.List<FieldType>
getFields()
java.lang.String
getImplementing()
Interface this message is implementing.java.lang.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()
Get a builder that extends the current object.int
numAnnotations()
int
numFields()
java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>
optionalAnnotations()
java.util.Optional<java.lang.String>
optionalDocumentation()
Documentation for the specific declaration.java.util.Optional<java.lang.String>
optionalImplementing()
Interface this message is implementing.java.util.Optional<MessageVariant>
optionalVariant()
static PStructDescriptorProvider<MessageType>
provider()
java.lang.String
toString()
int
writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer)
Write the current message to the binary writer.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.morimekta.providence.PMessageOrBuilder
toBuilder, toMessage
-
-
-
-
Field Detail
-
kDescriptor
public static final PStructDescriptor<MessageType> kDescriptor
-
-
Method Detail
-
hasDocumentation
public boolean hasDocumentation()
- Specified by:
hasDocumentation
in interfaceDecl
- Returns:
- If documentation is present.
-
getDocumentation
public java.lang.String getDocumentation()
Description copied from interface:Decl
Documentation for the specific declaration.- Specified by:
getDocumentation
in interfaceDecl
- Returns:
- The
documentation
value
-
optionalDocumentation
@Nonnull public java.util.Optional<java.lang.String> optionalDocumentation()
Description copied from interface:Decl
Documentation for the specific declaration.- Specified by:
optionalDocumentation
in interfaceDecl
- Returns:
- Optional of the
documentation
field value.
-
hasVariant
public boolean hasVariant()
- Specified by:
hasVariant
in interfaceMessageType_OrBuilder
- Returns:
- If variant is present.
-
getVariant
public MessageVariant getVariant()
- Specified by:
getVariant
in interfaceMessageType_OrBuilder
- Returns:
- The
variant
value
-
optionalVariant
@Nonnull public java.util.Optional<MessageVariant> optionalVariant()
- Specified by:
optionalVariant
in interfaceMessageType_OrBuilder
- Returns:
- Optional of the
variant
field value.
-
hasName
public boolean hasName()
-
getName
@Nonnull public java.lang.String getName()
Description copied from interface:Decl
Name of the type, constant or service.
-
numFields
public int numFields()
- Specified by:
numFields
in interfaceMessageType_OrBuilder
- Returns:
- Number of entries in fields.
-
hasFields
public boolean hasFields()
- Specified by:
hasFields
in interfaceMessageType_OrBuilder
- Returns:
- If fields is present.
-
getFields
@Nonnull public java.util.List<FieldType> getFields()
- Specified by:
getFields
in interfaceMessageType_OrBuilder
- Returns:
- The
fields
value
-
numAnnotations
public int numAnnotations()
- Specified by:
numAnnotations
in interfaceMessageType_OrBuilder
- Returns:
- Number of entries in annotations.
-
hasAnnotations
public boolean hasAnnotations()
- Specified by:
hasAnnotations
in interfaceMessageType_OrBuilder
- Returns:
- If annotations is present.
-
getAnnotations
public java.util.Map<java.lang.String,java.lang.String> getAnnotations()
- Specified by:
getAnnotations
in interfaceMessageType_OrBuilder
- Returns:
- The
annotations
value
-
optionalAnnotations
@Nonnull public java.util.Optional<java.util.Map<java.lang.String,java.lang.String>> optionalAnnotations()
- Specified by:
optionalAnnotations
in interfaceMessageType_OrBuilder
- Returns:
- Optional of the
annotations
field value.
-
hasImplementing
public boolean hasImplementing()
- Specified by:
hasImplementing
in interfaceMessageType_OrBuilder
- Returns:
- If implementing is present.
-
getImplementing
public java.lang.String getImplementing()
Interface this message is implementing.- Specified by:
getImplementing
in interfaceMessageType_OrBuilder
- Returns:
- The
implementing
value
-
optionalImplementing
@Nonnull public java.util.Optional<java.lang.String> optionalImplementing()
Interface this message is implementing.- Specified by:
optionalImplementing
in interfaceMessageType_OrBuilder
- Returns:
- Optional of the
implementing
field value.
-
has
public boolean has(int key)
- Specified by:
has
in interfacePMessageOrBuilder<MessageType>
- Parameters:
key
- The key of the field.- Returns:
- Whether the field is present.
-
get
public <T> T get(int key)
- Specified by:
get
in interfacePMessageOrBuilder<MessageType>
- Type Parameters:
T
- The return type.- Parameters:
key
- The key of the field.- Returns:
- The value of the field.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
asString
@Nonnull public java.lang.String asString()
Description copied from interface:PMessage
Pure string representation of content. Does not contain type info.- Specified by:
asString
in interfacePMessage<MessageType>
- Specified by:
asString
in interfacenet.morimekta.util.Stringable
- Returns:
- String representation.
-
compareTo
public int compareTo(MessageType other)
- Specified by:
compareTo
in interfacejava.lang.Comparable<MessageType>
-
writeBinary
public int writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer) throws java.io.IOException
Description copied from interface:BinaryWriter
Write the current message to the binary writer. NOTE: This method is not intended to be used directly. Instead use theBinarySerializer.serialize(OutputStream, PMessageOrBuilder)
call.- Specified by:
writeBinary
in interfaceBinaryWriter
- Parameters:
writer
- The binary writer to write to.- Returns:
- The number of bytes written.
- Throws:
java.io.IOException
- If it failed to write the message for any reason.
-
mutate
@Nonnull public MessageType._Builder mutate()
Description copied from interface:PMessage
Get a builder that extends the current object.- Specified by:
mutate
in interfacePMessage<MessageType>
- Returns:
- The builder instance.
-
provider
@Nonnull public static PStructDescriptorProvider<MessageType> provider()
-
descriptor
@Nonnull public PStructDescriptor<MessageType> descriptor()
- Specified by:
descriptor
in interfacePMessageOrBuilder<MessageType>
- Specified by:
descriptor
in interfacePValue<MessageType>
-
builder
public static MessageType._Builder builder()
Make ap_model.MessageType
builder.- Returns:
- The builder instance.
-
-