Interface Parser<MessageType>

public interface Parser<MessageType>

Abstract interface for parsing Protocol Messages.

The implementation should be stateless and thread-safe.

All methods may throw InvalidProtocolBufferException. In the event of invalid data, like an encoding error, the cause of the thrown exception will be null. However, if an I/O problem occurs, an exception is thrown with an java.io.IOException cause.

Type Parameter

NameDescription
MessageType

Methods

parseDelimitedFrom(InputStream input)

public abstract MessageType parseDelimitedFrom(InputStream input)

Like #parseFrom(InputStream), but does not read until EOF. Instead, the size of message (encoded as a varint) is read first, then the message data. Use MessageLite#writeDelimitedTo(java.io.OutputStream) to write messages in this format.

Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MessageType

Parsed message if successful, or null if the stream is at EOF when the method starts. Any other error (including reaching EOF during parsing) will cause an exception to be thrown.

Exceptions
TypeDescription
InvalidProtocolBufferException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Like #parseDelimitedFrom(InputStream) but supporting extensions.

Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data)

public abstract MessageType parseFrom(byte[] data)

Parses data as a message of MessageType. This is just a small wrapper around #parseFrom(CodedInputStream).

Parameter
NameDescription
databyte[]
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parses data as a message of MessageType. This is just a small wrapper around #parseFrom(CodedInputStream, ExtensionRegistryLite).

Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, int off, int len)

public abstract MessageType parseFrom(byte[] data, int off, int len)

Parses data as a message of MessageType. This is just a small wrapper around #parseFrom(CodedInputStream).

Parameters
NameDescription
databyte[]
offint
lenint
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parseFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry)

Parses data as a message of MessageType. This is just a small wrapper around #parseFrom(CodedInputStream, ExtensionRegistryLite).

Parameters
NameDescription
databyte[]
offint
lenint
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public abstract MessageType parseFrom(ByteString data)

Parses data as a message of MessageType. This is just a small wrapper around #parseFrom(CodedInputStream).

Parameter
NameDescription
dataByteString
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parses data as a message of MessageType. This is just a small wrapper around #parseFrom(CodedInputStream, ExtensionRegistryLite).

Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public abstract MessageType parseFrom(CodedInputStream input)

Parses a message of MessageType from the input.

Note: The caller should call CodedInputStream#checkLastTagWas(int) after calling this to verify that the last tag seen was the appropriate end-group tag, or zero for EOF.

Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Like #parseFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.

Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(InputStream input)

public abstract MessageType parseFrom(InputStream input)

Parse a message of MessageType from input. This is just a small wrapper around #parseFrom(CodedInputStream). Note that this method always reads the entire input (unless it throws an exception). If you want it to stop earlier, you will need to wrap your input in some wrapper stream that limits reading. Or, use MessageLite#writeDelimitedTo(java.io.OutputStream) to write your message and #parseDelimitedFrom(InputStream) to read it.

Despite usually reading the entire input, this does not close the stream.

Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parses a message of MessageType from input. This is just a small wrapper around #parseFrom(CodedInputStream, ExtensionRegistryLite).

Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data)

public abstract MessageType parseFrom(ByteBuffer data)

Parses data as a message of MessageType. This is just a small wrapper around #parseFrom(CodedInputStream).

Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parses data as a message of MessageType. This is just a small wrapper around #parseFrom(CodedInputStream, ExtensionRegistryLite).

Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialDelimitedFrom(InputStream input)

public abstract MessageType parsePartialDelimitedFrom(InputStream input)

Like #parseDelimitedFrom(InputStream), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parsePartialDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Like #parseDelimitedFrom(InputStream, ExtensionRegistryLite), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialFrom(byte[] data)

public abstract MessageType parsePartialFrom(byte[] data)

Like #parseFrom(byte[]), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameter
NameDescription
databyte[]
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parsePartialFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Like #parseFrom(byte[], ExtensionRegistryLite), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialFrom(byte[] data, int off, int len)

public abstract MessageType parsePartialFrom(byte[] data, int off, int len)

Like #parseFrom(byte[], int, int), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameters
NameDescription
databyte[]
offint
lenint
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parsePartialFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry)

Like #parseFrom(ByteString, ExtensionRegistryLite), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameters
NameDescription
databyte[]
offint
lenint
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialFrom(ByteString data)

public abstract MessageType parsePartialFrom(ByteString data)

Like #parseFrom(ByteString), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameter
NameDescription
dataByteString
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parsePartialFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Like #parseFrom(ByteString, ExtensionRegistryLite), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialFrom(CodedInputStream input)

public abstract MessageType parsePartialFrom(CodedInputStream input)

Like #parseFrom(CodedInputStream), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parsePartialFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Like #parseFrom(CodedInputStream input, ExtensionRegistryLite), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialFrom(InputStream input)

public abstract MessageType parsePartialFrom(InputStream input)

Like #parseFrom(InputStream), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException

parsePartialFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public abstract MessageType parsePartialFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Like #parseFrom(InputStream, ExtensionRegistryLite), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MessageType
Exceptions
TypeDescription
InvalidProtocolBufferException