Protocol Buffers [Core] 3.7.1 · com.google.protobuf.Parser

Method Summary

Modifier and Type	Method and Description
public MessageType	Returns: 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. parseDelimitedFrom(InputStream input) Like `parseFrom(InputStream)`, but does not read until EOF.
public MessageType	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) Like `parseDelimitedFrom(InputStream)` but supporting extensions.
public MessageType	parseFrom(CodedInputStream input) Parses a message of `MessageType` from the input.
public MessageType	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) Like `parseFrom(CodedInputStream)`, but also parses extensions.
public MessageType	parseFrom(ByteBuffer data) Parses `data` as a message of `MessageType`.
public MessageType	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) Parses `data` as a message of `MessageType`.
public MessageType	parseFrom(ByteString data) Parses `data` as a message of `MessageType`.
public MessageType	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) Parses `data` as a message of `MessageType`.
public MessageType	parseFrom(byte[] data, int off, int len) Parses `data` as a message of `MessageType`.
public MessageType	parseFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) Parses `data` as a message of `MessageType`.
public MessageType	parseFrom(byte[] data) Parses `data` as a message of `MessageType`.
public MessageType	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) Parses `data` as a message of `MessageType`.
public MessageType	parseFrom(InputStream input) Parse a message of `MessageType` from `input`.
public MessageType	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) Parses a message of `MessageType` from `input`.
public MessageType	parsePartialDelimitedFrom(InputStream input) Like `parseDelimitedFrom(InputStream)`, but does not throw an exception if the message is missing required fields.
public MessageType	parsePartialDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) Like `parseDelimitedFrom(InputStream, ExtensionRegistryLite)`, but does not throw an exception if the message is missing required fields.
public MessageType	parsePartialFrom(CodedInputStream input) Like `parseFrom(CodedInputStream)`, but does not throw an exception if the message is missing required fields.
public MessageType	parsePartialFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) Like `parseFrom(CodedInputStream input, ExtensionRegistryLite)`, but does not throw an exception if the message is missing required fields.
public MessageType	parsePartialFrom(ByteString data) Like `parseFrom(ByteString)`, but does not throw an exception if the message is missing required fields.
public MessageType	parsePartialFrom(ByteString data, ExtensionRegistryLite extensionRegistry) Like `parseFrom(ByteString, ExtensionRegistryLite)`, but does not throw an exception if the message is missing required fields.
public 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.
public 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.
public MessageType	parsePartialFrom(byte[] data) Like `parseFrom(byte[])`, but does not throw an exception if the message is missing required fields.
public MessageType	parsePartialFrom(byte[] data, ExtensionRegistryLite extensionRegistry) Like `parseFrom(byte[], ExtensionRegistryLite)`, but does not throw an exception if the message is missing required fields.
public MessageType	parsePartialFrom(InputStream input) Like `parseFrom(InputStream)`, but does not throw an exception if the message is missing required fields.
public MessageType	parsePartialFrom(InputStream input, ExtensionRegistryLite extensionRegistry) Like `parseFrom(InputStream, ExtensionRegistryLite)`, but does not throw an exception if the message is missing required fields.

Method Detail

parseDelimitedFrom back to summary

parseDelimitedFrom	back to summary
public MessageType parseDelimitedFrom(InputStream input) throws InvalidProtocolBufferException 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. Returns: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.

public MessageType parseDelimitedFrom(InputStream input) throws InvalidProtocolBufferException

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.

Returns: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.

parseDelimitedFrom	back to summary
public MessageType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Like `parseDelimitedFrom(InputStream)` but supporting extensions.

parseFrom	back to summary
public MessageType parseFrom(CodedInputStream input) throws InvalidProtocolBufferException 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.

parseFrom	back to summary
public MessageType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException 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.

parseFrom	back to summary
public MessageType parseFrom(ByteBuffer data) throws InvalidProtocolBufferException Parses `data` as a message of `MessageType`. This is just a small wrapper around `parseFrom(CodedInputStream)`.

parseFrom	back to summary
public MessageType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Parses `data` as a message of `MessageType`. This is just a small wrapper around `parseFrom(CodedInputStream, ExtensionRegistryLite)`.

parseFrom	back to summary
public MessageType parseFrom(ByteString data) throws InvalidProtocolBufferException Parses `data` as a message of `MessageType`. This is just a small wrapper around `parseFrom(CodedInputStream)`.

parseFrom	back to summary
public MessageType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Parses `data` as a message of `MessageType`. This is just a small wrapper around `parseFrom(CodedInputStream, ExtensionRegistryLite)`.

parseFrom	back to summary
public MessageType parseFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException Parses `data` as a message of `MessageType`. This is just a small wrapper around `parseFrom(CodedInputStream)`.

parseFrom	back to summary
public MessageType parseFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Parses `data` as a message of `MessageType`. This is just a small wrapper around `parseFrom(CodedInputStream, ExtensionRegistryLite)`.

parseFrom	back to summary
public MessageType parseFrom(byte[] data) throws InvalidProtocolBufferException Parses `data` as a message of `MessageType`. This is just a small wrapper around `parseFrom(CodedInputStream)`.

parseFrom	back to summary
public MessageType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Parses `data` as a message of `MessageType`. This is just a small wrapper around `parseFrom(CodedInputStream, ExtensionRegistryLite)`.

parseFrom back to summary

parseFrom	back to summary
public MessageType parseFrom(InputStream input) throws InvalidProtocolBufferException 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.

public MessageType parseFrom(InputStream input) throws InvalidProtocolBufferException

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.

parseFrom	back to summary
public MessageType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Parses a message of `MessageType` from `input`. This is just a small wrapper around `parseFrom(CodedInputStream, ExtensionRegistryLite)`.

parsePartialDelimitedFrom	back to summary
public MessageType parsePartialDelimitedFrom(InputStream input) throws InvalidProtocolBufferException Like `parseDelimitedFrom(InputStream)`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

parsePartialDelimitedFrom	back to summary
public MessageType parsePartialDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Like `parseDelimitedFrom(InputStream, ExtensionRegistryLite)`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

parsePartialFrom	back to summary
public MessageType parsePartialFrom(CodedInputStream input) throws InvalidProtocolBufferException Like `parseFrom(CodedInputStream)`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

parsePartialFrom	back to summary
public MessageType parsePartialFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Like `parseFrom(CodedInputStream input, ExtensionRegistryLite)`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

parsePartialFrom	back to summary
public MessageType parsePartialFrom(ByteString data) throws InvalidProtocolBufferException Like `parseFrom(ByteString)`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

parsePartialFrom	back to summary
public MessageType parsePartialFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Like `parseFrom(ByteString, ExtensionRegistryLite)`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

parsePartialFrom	back to summary
public MessageType parsePartialFrom(byte[] data, int off, int len) throws InvalidProtocolBufferException Like `parseFrom(byte[], int, int)`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

parsePartialFrom	back to summary
public MessageType parsePartialFrom(byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Like `parseFrom(ByteString, ExtensionRegistryLite)`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

parsePartialFrom	back to summary
public MessageType parsePartialFrom(byte[] data) throws InvalidProtocolBufferException Like `parseFrom(byte[])`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

parsePartialFrom	back to summary
public MessageType parsePartialFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Like `parseFrom(byte[], ExtensionRegistryLite)`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

parsePartialFrom	back to summary
public MessageType parsePartialFrom(InputStream input) throws InvalidProtocolBufferException Like `parseFrom(InputStream)`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

parsePartialFrom	back to summary
public MessageType parsePartialFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException Like `parseFrom(InputStream, ExtensionRegistryLite)`, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned.

public Interface Parser<MessageType>

Method Summary

Method Detail