com.google.protobuf.nano

Class MessageNano

java.lang.Object

com.google.protobuf.nano.MessageNano

Direct Known Subclasses:

ExtendableMessageNano

public abstract class MessageNano
extends Object

Abstract interface implemented by Protocol Message objects.

Author:

wink@google.com Wink Saville

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cachedSize

Constructor Summary

Constructors

Constructor and Description
MessageNano()

Method Summary

Methods

Modifier and Type	Method and Description
MessageNano	clone() Provides support for cloning.
protected int	computeSerializedSize() Computes the number of bytes required to encode this message.
int	getCachedSize() Get the number of bytes required to encode this message.
int	getSerializedSize() Computes the number of bytes required to encode this message.
abstract MessageNano	mergeFrom(CodedInputByteBufferNano input) Parse input as a message of this type and merge it with the message being built.
static <T extends MessageNano> 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 MessageNano> 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 boolean	messageNanoEquals(MessageNano a, MessageNano b) Compares two MessageNanos and returns true if the message's are the same class and have serialized form equality (i.e.
static byte[]	toByteArray(MessageNano msg) Serialize to a byte array.
static void	toByteArray(MessageNano msg, byte[] data, int offset, int length) Serialize to a byte array starting at offset through length.
String	toString() Returns a string that is (mostly) compatible with ProtoBuffer's TextFormat.
void	writeTo(CodedOutputByteBufferNano output) Serializes the message and writes it to output.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cachedSize

protected volatile int cachedSize

Constructor Detail

MessageNano

public MessageNano()

Method Detail

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.

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().

computeSerializedSize

protected int computeSerializedSize()

Computes the number of bytes required to encode this message. This does not update the cached size.

writeTo

public void writeTo(CodedOutputByteBufferNano 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.

mergeFrom

public abstract MessageNano mergeFrom(CodedInputByteBufferNano input)
                               throws IOException

Parse input as a message of this type and merge it with the message being built.

Throws:

IOException

toByteArray

public static final byte[] toByteArray(MessageNano msg)

Serialize to a byte array.

Returns:

byte array with the serialized data.

toByteArray

public static final void toByteArray(MessageNano 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 final <T extends MessageNano> T mergeFrom(T msg,
                                  byte[] data)
                                             throws InvalidProtocolBufferNanoException

Parse data as a message of this type and merge it with the message being built.

Throws:

InvalidProtocolBufferNanoException

mergeFrom

public static final <T extends MessageNano> T mergeFrom(T msg,
                                  byte[] data,
                                  int off,
                                  int len)
                                             throws InvalidProtocolBufferNanoException

Parse data as a message of this type and merge it with the message being built.

Throws:

InvalidProtocolBufferNanoException

messageNanoEquals

public static final boolean messageNanoEquals(MessageNano a,
                        MessageNano b)

Compares two MessageNanos and returns true if the message's are the same class and have serialized form equality (i.e. all of the field values are the same).

toString

public String toString()

Returns a string that is (mostly) compatible with ProtoBuffer's TextFormat. Note that groups (which are deprecated) are not serialized with the correct field name.

This is implemented using reflection, so it is not especially fast nor is it guaranteed to find all fields if you have method removal turned on for proguard.

Overrides:

toString in class Object

clone

public MessageNano clone()
                  throws CloneNotSupportedException

Provides support for cloning. This only works if you specify the generate_clone method.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException