public interface Parser<MessageType>
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 IOException
cause.
Modifier and Type | Method and Description |
---|---|
MessageType |
parseDelimitedFrom(java.io.InputStream input)
Like
parseFrom(InputStream) , but does not read until EOF. |
MessageType |
parseDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry)
Like
parseDelimitedFrom(InputStream) but supporting extensions. |
MessageType |
parseFrom(byte[] data)
Parses
data as a message of MessageType . |
MessageType |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry)
Parses
data as a message of MessageType . |
MessageType |
parseFrom(byte[] data,
int off,
int len)
Parses
data as a message of MessageType . |
MessageType |
parseFrom(byte[] data,
int off,
int len,
ExtensionRegistryLite extensionRegistry)
Parses
data as a message of MessageType . |
MessageType |
parseFrom(java.nio.ByteBuffer data)
Parses
data as a message of MessageType . |
MessageType |
parseFrom(java.nio.ByteBuffer data,
ExtensionRegistryLite extensionRegistry)
Parses
data as a message of MessageType . |
MessageType |
parseFrom(ByteString data)
Parses
data as a message of MessageType . |
MessageType |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry)
Parses
data as a message of MessageType . |
MessageType |
parseFrom(CodedInputStream input)
Parses a message of
MessageType from the input. |
MessageType |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry)
Like
parseFrom(CodedInputStream) , but also parses extensions. |
MessageType |
parseFrom(java.io.InputStream input)
Parse a message of
MessageType from input . |
MessageType |
parseFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry)
Parses a message of
MessageType from input . |
MessageType |
parsePartialDelimitedFrom(java.io.InputStream input)
Like
parseDelimitedFrom(InputStream) , but does not throw an exception if the message
is missing required fields. |
MessageType |
parsePartialDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry)
Like
parseDelimitedFrom(InputStream, ExtensionRegistryLite) , but does not throw an
exception if the message is missing required fields. |
MessageType |
parsePartialFrom(byte[] data)
Like
parseFrom(byte[]) , but does not throw an exception if the message is missing
required fields. |
MessageType |
parsePartialFrom(byte[] data,
ExtensionRegistryLite extensionRegistry)
Like
parseFrom(byte[], ExtensionRegistryLite) , but does not throw an exception if the
message is missing required fields. |
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. |
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. |
MessageType |
parsePartialFrom(ByteString data)
Like
parseFrom(ByteString) , but does not throw an exception if the message is missing
required fields. |
MessageType |
parsePartialFrom(ByteString data,
ExtensionRegistryLite extensionRegistry)
Like
parseFrom(ByteString, ExtensionRegistryLite) , but does not throw an exception if
the message is missing required fields. |
MessageType |
parsePartialFrom(CodedInputStream input)
Like
parseFrom(CodedInputStream) , but does not throw an exception if the message is
missing required fields. |
MessageType |
parsePartialFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry)
Like
parseFrom(CodedInputStream input, ExtensionRegistryLite) , but does not throw an
exception if the message is missing required fields. |
MessageType |
parsePartialFrom(java.io.InputStream input)
Like
parseFrom(InputStream) , but does not throw an exception if the message is missing
required fields. |
MessageType |
parsePartialFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry)
Like
parseFrom(InputStream, ExtensionRegistryLite) , but does not throw an exception if
the message is missing required fields. |
MessageType parseFrom(CodedInputStream input) throws InvalidProtocolBufferException
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.
InvalidProtocolBufferException
MessageType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
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.InvalidProtocolBufferException
MessageType parsePartialFrom(CodedInputStream input) throws InvalidProtocolBufferException
parseFrom(CodedInputStream)
, but does not throw an exception if the message is
missing required fields. Instead, a partial message is returned.InvalidProtocolBufferException
MessageType parsePartialFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
parseFrom(CodedInputStream input, ExtensionRegistryLite)
, but does not throw an
exception if the message is missing required fields. Instead, a partial message is returned.InvalidProtocolBufferException
MessageType parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
data
as a message of MessageType
. This is just a small wrapper around
parseFrom(CodedInputStream)
.InvalidProtocolBufferException
MessageType parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
data
as a message of MessageType
. This is just a small wrapper around
parseFrom(CodedInputStream, ExtensionRegistryLite)
.InvalidProtocolBufferException
MessageType parseFrom(ByteString data) throws InvalidProtocolBufferException
data
as a message of MessageType
. This is just a small wrapper around
parseFrom(CodedInputStream)
.InvalidProtocolBufferException
MessageType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
data
as a message of MessageType
. This is just a small wrapper around
parseFrom(CodedInputStream, ExtensionRegistryLite)
.InvalidProtocolBufferException
MessageType parsePartialFrom(ByteString data) throws InvalidProtocolBufferException
parseFrom(ByteString)
, but does not throw an exception if the message is missing
required fields. Instead, a partial message is returned.InvalidProtocolBufferException
MessageType parsePartialFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
parseFrom(ByteString, ExtensionRegistryLite)
, but does not throw an exception if
the message is missing required fields. Instead, a partial message is returned.InvalidProtocolBufferException
MessageType parseFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException
data
as a message of MessageType
. This is just a small wrapper around
parseFrom(CodedInputStream)
.InvalidProtocolBufferException
MessageType parseFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
data
as a message of MessageType
. This is just a small wrapper around
parseFrom(CodedInputStream, ExtensionRegistryLite)
.InvalidProtocolBufferException
MessageType parseFrom(byte[] data) throws InvalidProtocolBufferException
data
as a message of MessageType
. This is just a small wrapper around
parseFrom(CodedInputStream)
.InvalidProtocolBufferException
MessageType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
data
as a message of MessageType
. This is just a small wrapper around
parseFrom(CodedInputStream, ExtensionRegistryLite)
.InvalidProtocolBufferException
MessageType parsePartialFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException
parseFrom(byte[], int, int)
, but does not throw an exception if the message is
missing required fields. Instead, a partial message is returned.InvalidProtocolBufferException
MessageType parsePartialFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
parseFrom(ByteString, ExtensionRegistryLite)
, but does not throw an exception if
the message is missing required fields. Instead, a partial message is returned.InvalidProtocolBufferException
MessageType parsePartialFrom(byte[] data) throws InvalidProtocolBufferException
parseFrom(byte[])
, but does not throw an exception if the message is missing
required fields. Instead, a partial message is returned.InvalidProtocolBufferException
MessageType parsePartialFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
parseFrom(byte[], ExtensionRegistryLite)
, but does not throw an exception if the
message is missing required fields. Instead, a partial message is returned.InvalidProtocolBufferException
MessageType parseFrom(java.io.InputStream input) throws InvalidProtocolBufferException
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.
InvalidProtocolBufferException
MessageType parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType
from input
. This is just a small wrapper around
parseFrom(CodedInputStream, ExtensionRegistryLite)
.InvalidProtocolBufferException
MessageType parsePartialFrom(java.io.InputStream input) throws InvalidProtocolBufferException
parseFrom(InputStream)
, but does not throw an exception if the message is missing
required fields. Instead, a partial message is returned.InvalidProtocolBufferException
MessageType parsePartialFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
parseFrom(InputStream, ExtensionRegistryLite)
, but does not throw an exception if
the message is missing required fields. Instead, a partial message is returned.InvalidProtocolBufferException
MessageType parseDelimitedFrom(java.io.InputStream input) throws InvalidProtocolBufferException
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.InvalidProtocolBufferException
MessageType parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
parseDelimitedFrom(InputStream)
but supporting extensions.InvalidProtocolBufferException
MessageType parsePartialDelimitedFrom(java.io.InputStream input) throws InvalidProtocolBufferException
parseDelimitedFrom(InputStream)
, but does not throw an exception if the message
is missing required fields. Instead, a partial message is returned.InvalidProtocolBufferException
MessageType parsePartialDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
parseDelimitedFrom(InputStream, ExtensionRegistryLite)
, but does not throw an
exception if the message is missing required fields. Instead, a partial message is returned.InvalidProtocolBufferException
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.