Protocol Buffer JavaNano API 3.1.0 · com.google.protobuf.nano.MessageNano

Modifier and Type	Field and Description
protected volatile int	cachedSize

Access	Constructor and Description
public	MessageNano()

Method Summary

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

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll wait wait wait

cachedSize	back to summary
protected volatile int cachedSize

MessageNano	back to summary
public MessageNano()

Method Detail

clone back to summary

clone	back to summary
public MessageNano clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Provides support for cloning. This only works if you specify the generate_clone method. Returns:MessageNano Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: Doc from java.lang.Object.clone. if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

public MessageNano clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

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

Returns:MessageNano

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:

Doc from java.lang.Object.clone.

if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

computeSerializedSize	back to summary
protected int computeSerializedSize() Computes the number of bytes required to encode this message. This does not update the cached size.

getCachedSize	back to summary
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	back to summary
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().

mergeFrom	back to summary
public abstract MessageNano mergeFrom(CodedInputByteBufferNano input) throws IOException Parse `input` as a message of this type and merge it with the message being built.

mergeFrom	back to summary
public static final <T extends MessageNano> T mergeFrom(T msg, final byte[] data) throws InvalidProtocolBufferNanoException Parse `data` as a message of this type and merge it with the message being built.

mergeFrom	back to summary
public static final <T extends MessageNano> T mergeFrom(T msg, final byte[] data, final int off, final int len) throws InvalidProtocolBufferNanoException Parse `data` as a message of this type and merge it with the message being built.

messageNanoEquals	back to summary
public static final boolean messageNanoEquals(MessageNano a, MessageNano b) Compares two `MessageNano`s 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).

toByteArray	back to summary
public static final byte[] toByteArray(MessageNano msg) Serialize to a byte array. Returns:byte[] byte array with the serialized data.

toByteArray

back to summary

public static final byte[] toByteArray(MessageNano msg)

Serialize to a byte array.

Returns:byte[]: byte array with the serialized data.

toByteArray	back to summary
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.

toByteArray

back to summary

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.

toString	back to summary
public String toString() Overrides java.lang.Object.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. Returns:String Doc from java.lang.Object.toString. a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.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.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

writeTo back to summary

writeTo	back to summary
public void writeTo(CodedOutputByteBufferNano output) throws IOException Serializes the message and writes it to `output`. Parameters output:CodedOutputByteBufferNano the output to receive the serialized form. Exceptions IOException: if an error occurred writing to `output`.

public void writeTo(CodedOutputByteBufferNano output) throws IOException

Serializes the message and writes it to output.

Parameters

output:CodedOutputByteBufferNano: the output to receive the serialized form.

Exceptions

IOException:: if an error occurred writing to output.

public abstract Class MessageNano

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail