ProtoMessage (quickbuf-runtime 1.4 API)

java.lang.Object
- us.hebi.quickbuf.ProtoMessage<MessageType>

```
public abstract class ProtoMessage<MessageType extends ProtoMessage<?>>
extends Object
```
Abstract interface implemented by Protocol Message objects.
API partially copied from Google's MessageNano

Author:

Florian Enner

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`bitField0_`
`protected int`	`cachedSize`
`protected static FieldName`	`unknownBytesFieldName` JSON field name for serializing unknown bytes.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ProtoMessage()

Constructors
Modifier	Constructor and Description
`protected`	`ProtoMessage()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected static byte[]`	`bytesDefaultValue(String bytes)` Helper to determine the default value for 'Bytes' fields.
`MessageType`	`checkInitialized()` Helper method to check if this message is initialized, i.e., if all required fields are set.
`abstract MessageType`	`clear()` Sets all fields and data to their default values.
`MessageType`	`clearQuick()` Clears all has state so that the message would serialize empty, but does not set field default values and does not get rid of memory that was allocated for repeated types.
`abstract MessageType`	`clone()` Creates a new instance of this message with the same content
`protected abstract int`	`computeSerializedSize()` Computes the number of bytes required to encode this message.
`abstract MessageType`	`copyFrom(MessageType other)` Copies all fields and data from another message of the same type into this message.
`abstract boolean`	`equals(Object obj)` Indicates whether another object is "equal to" this one.
`int`	`getCachedSize()` Get the number of bytes required to encode this message.
`List<String>`	`getMissingFields()`
`protected void`	`getMissingFields(String prefix, List<String> results)` Adds the full path to all missing required fields in the message
`protected static void`	`getMissingFields(String prefix, String fieldName, ProtoMessage<?> field, List<String> results)`
`protected static void`	`getMissingFields(String prefix, String fieldName, RepeatedMessage<?> field, List<String> results)`
`int`	`getSerializedSize()` Computes the number of bytes required to encode this message.
`RepeatedByte`	`getUnknownBytes()`
`int`	`hashCode()` Messages have no immutable state and should not be used in hashing structures.
`boolean`	`isEmpty()`
`boolean`	`isInitialized()`
`MessageType`	`mergeDelimitedFrom(ProtoSource input)` Merges the contents for one message written in length delimited form.
`MessageType`	`mergeFrom(JsonSource input)` Parse `input` as a message of this type and merge it with the message being built.
`MessageType`	`mergeFrom(MessageType other)` Merge `other` into the message being built.
`abstract MessageType`	`mergeFrom(ProtoSource input)` Parse `input` as a message of this type and merge it with the message being built.
`static <T extends ProtoMessage<T>> T`	`mergeFrom(T msg, byte[] data)` Parse `data` as a message of this type and merge it with the message being built.
`static <T extends ProtoMessage<T>> T`	`mergeFrom(T msg, byte[] data, int off, int len)` Parse `data` as a message of this type and merge it with the message being built.
`static <T extends ProtoMessage<T>> T`	`mergeFrom(T msg, JsonSource input)` Parse `input` as a message of this type and merge it with the message being built.
`static <T extends ProtoMessage<T>> T`	`mergeFrom(T msg, ProtoSource input)` Parse `input` as a message of this type and merge it with the message being built.
`protected UninitializedMessageException`	`rethrowFromParent(UninitializedMessageException ex)`
`byte[]`	`toByteArray()` Serialize to a byte array.
`static byte[]`	`toByteArray(ProtoMessage<?> msg)` Serialize to a byte array.
`static void`	`toByteArray(ProtoMessage<?> msg, byte[] data, int offset, int length)` Serialize to a byte array starting at offset through length.
`String`	`toString()` Returns a string that contains a human-readable representation of the contents.
`MessageType`	`writeDelimitedTo(ProtoSink output)` Serializes the message and writes it to the `output` in length delimited form.
`void`	`writeTo(JsonSink output)` Serializes this message in a JSON format compatible with https://developers.google.com/protocol-buffers/docs/proto3#json.
`abstract void`	`writeTo(ProtoSink output)` Serializes the message and writes it to `output`.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - cachedSize
```
protected int cachedSize
```
  - bitField0_
```
protected int bitField0_
```
  - unknownBytesFieldName
```
protected static final FieldName unknownBytesFieldName
```
    JSON field name for serializing unknown bytes. Protobuf handles JSON serialized extensions with the full field name surrounded by brackets. This is not part of the spec, so an extension seems appropriate and won't collide with a specified "unknown_bytes" field.
- Constructor Detail
  - ProtoMessage
```
protected ProtoMessage()
```
- Method Detail
  - copyFrom
```
public abstract MessageType copyFrom(MessageType other)
```
    Copies all fields and data from another message of the same type into this message.
    
    Parameters:
    
    other - message with the contents to be copied
    
    Returns:
    
    this
  - clear
```
public abstract MessageType clear()
```
    Sets all fields and data to their default values. Does not get rid of memory that was allocated.
    
    Returns:
    
    this
  - clearQuick
```
public MessageType clearQuick()
```
    Clears all has state so that the message would serialize empty, but does not set field default values and does not get rid of memory that was allocated for repeated types.
    Use this if you use this message for serialization purposes or if you do not require default values for unset fields.
    
    Returns:
    
    this
  - isEmpty
```
public boolean isEmpty()
```
    Returns:
    
    true if none of the fields in this message are set
  - isInitialized
```
public boolean isInitialized()
```
    Returns:
    
    true if all required fields in this message and in nested messages are set
  - checkInitialized
```
public final MessageType checkInitialized()
                                   throws InvalidProtocolBufferException
```
    Helper method to check if this message is initialized, i.e., if all required fields are set.
    Message content is not automatically checked after merging new data. This method should be called manually as needed.
    
    Returns:
    
    this
    
    Throws:
    
    InvalidProtocolBufferException - if it is not initialized.
  - getCachedSize
```
public int getCachedSize()
```
    Get the number of bytes required to encode this message. Returns the cached size or calls getSerializedSize which sets the cached size. This is used internally when serializing so the size is only computed once. If a member is modified then this could be stale call getSerializedSize if in doubt.
    
    Returns:
    
    the cached size of the serialized proto form
  - getSerializedSize
```
public int getSerializedSize()
```
    Computes the number of bytes required to encode this message. The size is cached and the cached result can be retrieved using getCachedSize().
    
    Returns:
    
    the size of the serialized proto form
  - computeSerializedSize
```
protected abstract int computeSerializedSize()
```
    Computes the number of bytes required to encode this message. This does not update the cached size.
    
    Returns:
    
    the size of the serialized proto form
  - writeTo
```
public abstract void writeTo(ProtoSink output)
                      throws IOException
```
    Serializes the message and writes it to output.
    
    Parameters:
    
    output - the output to receive the serialized form.
    
    Throws:
    
    IOException - if an error occurred writing to output.
  - writeDelimitedTo
```
public MessageType writeDelimitedTo(ProtoSink output)
                             throws IOException
```
    Serializes the message and writes it to the output in length delimited form.
    
    Returns:
    
    this
    
    Throws:
    
    IOException
  - mergeDelimitedFrom
```
public MessageType mergeDelimitedFrom(ProtoSource input)
                               throws IOException
```
    Merges the contents for one message written in length delimited form.
    
    Returns:
    
    this
    
    Throws:
    
    IOException
  - mergeFrom
```
public abstract MessageType mergeFrom(ProtoSource input)
                               throws IOException
```
    Parse input as a message of this type and merge it with the message being built.
    
    Returns:
    
    this
    
    Throws:
    
    IOException
  - mergeFrom
```
public MessageType mergeFrom(MessageType other)
```
    Merge other into the message being built. other must have the exact same type as this.
    Merging occurs as follows. For each field:
    * For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
    * For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
    * For repeated fields, the elements in other are concatenated with the elements in this message.
    * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.
    This is equivalent to the Message::MergeFrom method in C++.
    
    Returns:
    
    this
  - writeTo
```
public void writeTo(JsonSink output)
             throws IOException
```
    Serializes this message in a JSON format compatible with https://developers.google.com/protocol-buffers/docs/proto3#json.
    The implementation may not fail on missing required fields, so required fields would need to be checked using isInitialized().
    
    Parameters:
    
    output - json sink
    
    Throws:
    
    IOException
  - mergeFrom
```
public MessageType mergeFrom(JsonSource input)
                      throws IOException
```
    Parse input as a message of this type and merge it with the message being built.
    
    Returns:
    
    this
    
    Throws:
    
    IOException
  - toByteArray
```
public final byte[] toByteArray()
```
    Serialize to a byte array.
    
    Returns:
    
    byte array with the serialized data.
  - toByteArray
```
public static byte[] toByteArray(ProtoMessage<?> msg)
```
    Serialize to a byte array.
    
    Returns:
    
    byte array with the serialized data.
  - toByteArray
```
public static void toByteArray(ProtoMessage<?> msg,
                               byte[] data,
                               int offset,
                               int length)
```
    Serialize to a byte array starting at offset through length. The method getSerializedSize must have been called prior to calling this method so the proper length is know. If an attempt to write more than length bytes OutOfSpaceException will be thrown and if length bytes are not written then IllegalStateException is thrown.
  - mergeFrom
```
public static <T extends ProtoMessage<T>> T mergeFrom(T msg,
                                                      byte[] data)
                                               throws InvalidProtocolBufferException
```
    Parse data as a message of this type and merge it with the message being built.
    
    Throws:
    
    InvalidProtocolBufferException
  - mergeFrom
```
public static <T extends ProtoMessage<T>> T mergeFrom(T msg,
                                                      byte[] data,
                                                      int off,
                                                      int len)
                                               throws InvalidProtocolBufferException
```
    Parse data as a message of this type and merge it with the message being built.
    
    Throws:
    
    InvalidProtocolBufferException
  - mergeFrom
```
public static <T extends ProtoMessage<T>> T mergeFrom(T msg,
                                                      ProtoSource input)
                                               throws IOException
```
    Parse input as a message of this type and merge it with the message being built.
    
    Throws:
    
    IOException
  - mergeFrom
```
public static <T extends ProtoMessage<T>> T mergeFrom(T msg,
                                                      JsonSource input)
                                               throws IOException
```
    Parse input as a message of this type and merge it with the message being built.
    
    Throws:
    
    IOException
  - equals
```
public abstract boolean equals(Object obj)
```
    Indicates whether another object is "equal to" this one.
    An object is considered equal when it is of the same message type, contains the same fields (same has state), and all the field contents are equal.
    This comparison ignores unknown fields, so the serialized binary form may not be equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the reference object with which to compare
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
  - hashCode
```
public final int hashCode()
```
    Messages have no immutable state and should not be used in hashing structures. This implementation returns a constant value in order to satisfy the contract.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Returns a string that contains a human-readable representation of the contents. The output may not be compatible with any existing readers.
    
    Overrides:
    
    toString in class Object
  - clone
```
public abstract MessageType clone()
```
    Creates a new instance of this message with the same content
    
    Overrides:
    
    clone in class Object
  - getMissingFields
```
public List<String> getMissingFields()
```
    Returns:
    
    the full path to all missing required fields in the message
  - getMissingFields
```
protected void getMissingFields(String prefix,
                                List<String> results)
```
    Adds the full path to all missing required fields in the message
  - getMissingFields
```
protected static void getMissingFields(String prefix,
                                       String fieldName,
                                       ProtoMessage<?> field,
                                       List<String> results)
```
  - getMissingFields
```
protected static void getMissingFields(String prefix,
                                       String fieldName,
                                       RepeatedMessage<?> field,
                                       List<String> results)
```
  - rethrowFromParent
```
protected UninitializedMessageException rethrowFromParent(UninitializedMessageException ex)
```
  - bytesDefaultValue
```
protected static byte[] bytesDefaultValue(String bytes)
```
    Helper to determine the default value for 'Bytes' fields. The Protobuf generator encodes raw bytes as strings with ISO-8859-1 encoding.
  - getUnknownBytes
```
public RepeatedByte getUnknownBytes()
```
    Returns:
    
    binary representation of all fields with tags that could not be parsed

Class ProtoMessage<MessageType extends ProtoMessage<?>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cachedSize

bitField0_

unknownBytesFieldName

Constructor Detail

ProtoMessage

Method Detail

copyFrom

clear

clearQuick

isEmpty

isInitialized

checkInitialized

getCachedSize

getSerializedSize

computeSerializedSize

writeTo

writeDelimitedTo

mergeDelimitedFrom

mergeFrom

mergeFrom

writeTo

mergeFrom

toByteArray

toByteArray

toByteArray

mergeFrom

mergeFrom

mergeFrom

mergeFrom

equals

hashCode

toString

clone

getMissingFields

getMissingFields

getMissingFields

getMissingFields

rethrowFromParent

bytesDefaultValue

getUnknownBytes