com.google.protobuf.Parser< MessageType > Interface Template Reference

Inheritance diagram for com.google.protobuf.Parser< MessageType >:

Public Member Functions
MessageType	parseFrom (CodedInputStream input) throws InvalidProtocolBufferException
MessageType	parseFrom (CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType	parsePartialFrom (CodedInputStream input) throws InvalidProtocolBufferException
MessageType	parsePartialFrom (CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType	parseFrom (ByteString data) throws InvalidProtocolBufferException
MessageType	parseFrom (ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType	parsePartialFrom (ByteString data) throws InvalidProtocolBufferException
MessageType	parsePartialFrom (ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType	parseFrom (byte[] data, int off, int len) throws InvalidProtocolBufferException
MessageType	parseFrom (byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType	parseFrom (byte[] data) throws InvalidProtocolBufferException
MessageType	parseFrom (byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType	parsePartialFrom (byte[] data, int off, int len) throws InvalidProtocolBufferException
MessageType	parsePartialFrom (byte[] data, int off, int len, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType	parsePartialFrom (byte[] data) throws InvalidProtocolBufferException
MessageType	parsePartialFrom (byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType	parseFrom (InputStream input) throws InvalidProtocolBufferException
MessageType	parseFrom (InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType	parsePartialFrom (InputStream input) throws InvalidProtocolBufferException
MessageType	parsePartialFrom (InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType	parseDelimitedFrom (InputStream input) throws InvalidProtocolBufferException
MessageType	parseDelimitedFrom (InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
MessageType	parsePartialDelimitedFrom (InputStream input) throws InvalidProtocolBufferException
MessageType	parsePartialDelimitedFrom (InputStream input, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException

Detailed Description

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 IOException cause.

Author

liuji.nosp@m.si@g.nosp@m.oogle.nosp@m..com (Pherl Liu)

Member Function Documentation

parseDelimitedFrom() [1/2]

MessageType com.google.protobuf.Parser< MessageType >.parseDelimitedFrom

(

InputStream

input

)

throws InvalidProtocolBufferException

Like parseFrom(InputStream), but does not read util 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

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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parseDelimitedFrom() [2/2]

MessageType com.google.protobuf.Parser< MessageType >.parseDelimitedFrom	(	InputStream	input,
		ExtensionRegistryLite	extensionRegistry
	)		throws InvalidProtocolBufferException

Like parseDelimitedFrom(InputStream) but supporting extensions.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parseFrom() [1/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parseFrom() [2/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parseFrom() [3/10]

MessageType com.google.protobuf.Parser< MessageType >.parseFrom

(

ByteString

data

)

throws InvalidProtocolBufferException

Parses

data 

as a message of

MessageType 

. This is just a small wrapper around parseFrom(CodedInputStream).

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parseFrom() [4/10]

MessageType com.google.protobuf.Parser< 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).

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parseFrom() [5/10]

MessageType com.google.protobuf.Parser< 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).

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parseFrom() [6/10]

MessageType com.google.protobuf.Parser< 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).

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parseFrom() [7/10]

MessageType com.google.protobuf.Parser< MessageType >.parseFrom

(

byte []

data

)

throws InvalidProtocolBufferException

Parses

data 

as a message of

MessageType 

. This is just a small wrapper around parseFrom(CodedInputStream).

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parseFrom() [8/10]

MessageType com.google.protobuf.Parser< 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).

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parseFrom() [9/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parseFrom() [10/10]

MessageType com.google.protobuf.Parser< 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).

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parsePartialDelimitedFrom() [1/2]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parsePartialDelimitedFrom() [2/2]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parsePartialFrom() [1/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parsePartialFrom() [2/10]

MessageType com.google.protobuf.Parser< 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() [3/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parsePartialFrom() [4/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parsePartialFrom() [5/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parsePartialFrom() [6/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parsePartialFrom() [7/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parsePartialFrom() [8/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parsePartialFrom() [9/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

parsePartialFrom() [10/10]

MessageType com.google.protobuf.Parser< 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.

Implemented in com.google.protobuf.AbstractParser< MessageType extends MessageLite >.

---

The documentation for this interface was generated from the following file:

• Source/ThirdParty/libwebrtc/Source/third_party/protobuf/java/core/src/main/java/com/google/protobuf/Parser.java