com.google.protobuf.DynamicMessage Class Reference

Inheritance diagram for com.google.protobuf.DynamicMessage:

Classes
class	Builder

Public Member Functions
Map< FieldDescriptor, Object >	getAllFields ()
DynamicMessage	getDefaultInstanceForType ()
Descriptor	getDescriptorForType ()
Object	getField (FieldDescriptor field)
FieldDescriptor	getOneofFieldDescriptor (OneofDescriptor oneof)
Parser< DynamicMessage >	getParserForType ()
Object	getRepeatedField (FieldDescriptor field, int index)
int	getRepeatedFieldCount (FieldDescriptor field)
int	getSerializedSize ()
UnknownFieldSet	getUnknownFields ()
boolean	hasField (FieldDescriptor field)
boolean	hasOneof (OneofDescriptor oneof)
boolean	isInitialized ()
Builder	newBuilderForType ()
Builder	toBuilder ()
void	writeTo (CodedOutputStream output) throws IOException
Public Member Functions inherited from com.google.protobuf.AbstractMessage
boolean	equals (final Object other)
List< String >	findInitializationErrors ()
String	getInitializationErrorString ()
int	hashCode ()
final String	toString ()
Public Member Functions inherited from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >
byte[]	toByteArray ()
ByteString	toByteString ()
void	writeDelimitedTo (final OutputStream output) throws IOException
void	writeTo (final OutputStream output) throws IOException
Public Member Functions inherited from com.google.protobuf.MessageOrBuilder
Object	getField (Descriptors.FieldDescriptor field)
Descriptors.FieldDescriptor	getOneofFieldDescriptor (Descriptors.OneofDescriptor oneof)
Object	getRepeatedField (Descriptors.FieldDescriptor field, int index)
int	getRepeatedFieldCount (Descriptors.FieldDescriptor field)
boolean	hasField (Descriptors.FieldDescriptor field)
boolean	hasOneof (Descriptors.OneofDescriptor oneof)

Static Public Member Functions
static DynamicMessage	getDefaultInstance (Descriptor type)
static Builder	newBuilder (Descriptor type)
static Builder	newBuilder (Message prototype)
static DynamicMessage	parseFrom (Descriptor type, byte[] data) throws InvalidProtocolBufferException
static DynamicMessage	parseFrom (Descriptor type, byte[] data, ExtensionRegistry extensionRegistry) throws InvalidProtocolBufferException
static DynamicMessage	parseFrom (Descriptor type, ByteString data) throws InvalidProtocolBufferException
static DynamicMessage	parseFrom (Descriptor type, ByteString data, ExtensionRegistry extensionRegistry) throws InvalidProtocolBufferException
static DynamicMessage	parseFrom (Descriptor type, CodedInputStream input) throws IOException
static DynamicMessage	parseFrom (Descriptor type, CodedInputStream input, ExtensionRegistry extensionRegistry) throws IOException
static DynamicMessage	parseFrom (Descriptor type, InputStream input) throws IOException
static DynamicMessage	parseFrom (Descriptor type, InputStream input, ExtensionRegistry extensionRegistry) throws IOException

Private Member Functions
void	verifyContainingType (FieldDescriptor field)
void	verifyOneofContainingType (OneofDescriptor oneof)

Private Attributes
final FieldSet< FieldDescriptor >	fields
int	memoizedSize = -1
final FieldDescriptor[]	oneofCases
final Descriptor	type
final UnknownFieldSet	unknownFields

Additional Inherited Members
Protected Member Functions inherited from com.google.protobuf.AbstractMessage
Message.Builder	newBuilderForType (BuilderParent parent)
Static Protected Member Functions inherited from com.google.protobuf.AbstractMessage
static int	hashBoolean (boolean b)
static int	hashEnum (EnumLite e)
static int	hashEnumList (List<? extends EnumLite > list)
static int	hashFields (int hash, Map< FieldDescriptor, Object > map)
static int	hashLong (long n)
Static Protected Member Functions inherited from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >
static< T > void	addAll (final Iterable< T > values, final Collection<? super T > list)
static< T > void	addAll (final Iterable< T > values, final List<? super T > list)
static void	checkByteStringIsUtf8 (ByteString byteString) throws IllegalArgumentException
Protected Attributes inherited from com.google.protobuf.AbstractMessage
int	memoizedSize = -1
Protected Attributes inherited from com.google.protobuf.AbstractMessageLite< MessageType extends AbstractMessageLite< MessageType, BuilderType, BuilderType extends AbstractMessageLite.Builder< MessageType, BuilderType >
int	memoizedHashCode = 0

Detailed Description

An implementation of Message that can represent arbitrary types, given a {}. kento.nosp@m.n@go.nosp@m.ogle..nosp@m.com Kenton Varda

Definition at line 51 of file DynamicMessage.java.

Member Function Documentation

getAllFields()

Map<FieldDescriptor, Object> com.google.protobuf.DynamicMessage.getAllFields ( )

inline

Returns a collection of all the fields in this message which are set and their corresponding values. A singular ("required" or "optional") field is set iff hasField() returns true for that field. A "repeated" field is set iff getRepeatedFieldCount() is greater than zero. The values are exactly what would be returned by calling getField(Descriptors.FieldDescriptor) for each field. The map is guaranteed to be a sorted map, so iterating over it will return fields in order by field number.
If this is for a builder, the returned map may or may not reflect future changes to the builder. Either way, the returned map is itself unmodifiable.

Implements com.google.protobuf.MessageOrBuilder.

Definition at line 166 of file DynamicMessage.java.

getDefaultInstance()

static DynamicMessage com.google.protobuf.DynamicMessage.getDefaultInstance ( Descriptor  type )

inlinestatic

Get a

DynamicMessage 

representing the default instance of the given type.

Definition at line 78 of file DynamicMessage.java.

getDefaultInstanceForType()

DynamicMessage com.google.protobuf.DynamicMessage.getDefaultInstanceForType ( )

inline

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the

getDefaultInstance() 

method of generated message classes in that this method is an abstract method of the

MessageLite 

interface whereas

getDefaultInstance() 

is a static method of a specific class. They return the same thing.

Implements com.google.protobuf.MessageOrBuilder.

Definition at line 161 of file DynamicMessage.java.

getDescriptorForType()

Descriptor com.google.protobuf.DynamicMessage.getDescriptorForType ( )

inline

Get the message's type's descriptor. This differs from the

getDescriptor() 

method of generated message classes in that this method is an abstract method of the

Message 

interface whereas

getDescriptor() 

is a static method of a specific class. They return the same thing.

Implements com.google.protobuf.MessageOrBuilder.

Definition at line 156 of file DynamicMessage.java.

getField()

Object com.google.protobuf.DynamicMessage.getField ( FieldDescriptor  field )

inline

Definition at line 193 of file DynamicMessage.java.

getOneofFieldDescriptor()

FieldDescriptor com.google.protobuf.DynamicMessage.getOneofFieldDescriptor ( OneofDescriptor  oneof )

inline

TODO(jieluo): Clear it when all subclasses have implemented this method.

Reimplemented from com.google.protobuf.AbstractMessage.

Definition at line 181 of file DynamicMessage.java.

getParserForType()

Parser<DynamicMessage> com.google.protobuf.DynamicMessage.getParserForType ( )

inline

Gets the parser for a message of the same type as this message.

Implements com.google.protobuf.Message.

Definition at line 283 of file DynamicMessage.java.

getRepeatedField()

Object com.google.protobuf.DynamicMessage.getRepeatedField ( FieldDescriptor  field, int  index  )

inline

Definition at line 215 of file DynamicMessage.java.

getRepeatedFieldCount()

int com.google.protobuf.DynamicMessage.getRepeatedFieldCount ( FieldDescriptor  field )

inline

Definition at line 209 of file DynamicMessage.java.

getSerializedSize()

int com.google.protobuf.DynamicMessage.getSerializedSize ( )

inline

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.

Reimplemented from com.google.protobuf.AbstractMessage.

Definition at line 256 of file DynamicMessage.java.

getUnknownFields()

UnknownFieldSet com.google.protobuf.DynamicMessage.getUnknownFields ( )

inline

Get the UnknownFieldSet for this message.

Implements com.google.protobuf.MessageOrBuilder.

Definition at line 221 of file DynamicMessage.java.

hasField()

boolean com.google.protobuf.DynamicMessage.hasField ( FieldDescriptor  field )

inline

Definition at line 187 of file DynamicMessage.java.

hasOneof()

boolean com.google.protobuf.DynamicMessage.hasOneof ( OneofDescriptor  oneof )

inline

TODO(jieluo): Clear it when all subclasses have implemented this method.

Reimplemented from com.google.protobuf.AbstractMessage.

Definition at line 171 of file DynamicMessage.java.

isInitialized()

boolean com.google.protobuf.DynamicMessage.isInitialized ( )

inline

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder#getInitializationErrorString()

Reimplemented from com.google.protobuf.AbstractMessage.

Definition at line 240 of file DynamicMessage.java.

newBuilder() [1/2]

static Builder com.google.protobuf.DynamicMessage.newBuilder ( Descriptor  type )

inlinestatic

Construct a Message.Builder for the given type.

Definition at line 140 of file DynamicMessage.java.

newBuilder() [2/2]

static Builder com.google.protobuf.DynamicMessage.newBuilder ( Message  prototype )

inlinestatic

Construct a Message.Builder for a message of the same type as

prototype 

, and initialize it with

prototype 

's contents.

Definition at line 148 of file DynamicMessage.java.

newBuilderForType()

Builder com.google.protobuf.DynamicMessage.newBuilderForType ( )

inline

Constructs a new builder for a message of the same type as this message.

Implements com.google.protobuf.Message.

Definition at line 273 of file DynamicMessage.java.

parseFrom() [1/8]

static DynamicMessage com.google.protobuf.DynamicMessage.parseFrom ( Descriptor  type, byte[]  data  ) throws InvalidProtocolBufferException

inlinestatic

Parse

data 

as a message of the given type and return it.

Definition at line 116 of file DynamicMessage.java.

parseFrom() [2/8]

static DynamicMessage com.google.protobuf.DynamicMessage.parseFrom ( Descriptor  type, byte[]  data, ExtensionRegistry  extensionRegistry  ) throws InvalidProtocolBufferException

inlinestatic

Parse

data 

as a message of the given type and return it.

Definition at line 122 of file DynamicMessage.java.

parseFrom() [3/8]

static DynamicMessage com.google.protobuf.DynamicMessage.parseFrom ( Descriptor  type, ByteString  data  ) throws InvalidProtocolBufferException

inlinestatic

Parse

data 

as a message of the given type and return it.

Definition at line 103 of file DynamicMessage.java.

parseFrom() [4/8]

static DynamicMessage com.google.protobuf.DynamicMessage.parseFrom ( Descriptor  type, ByteString  data, ExtensionRegistry  extensionRegistry  ) throws InvalidProtocolBufferException

inlinestatic

Parse

data 

as a message of the given type and return it.

Definition at line 109 of file DynamicMessage.java.

parseFrom() [5/8]

static DynamicMessage com.google.protobuf.DynamicMessage.parseFrom ( Descriptor  type, CodedInputStream  input  ) throws IOException

inlinestatic

Parse a message of the given type from the given input stream.

Definition at line 90 of file DynamicMessage.java.

parseFrom() [6/8]

static DynamicMessage com.google.protobuf.DynamicMessage.parseFrom ( Descriptor  type, CodedInputStream  input, ExtensionRegistry  extensionRegistry  ) throws IOException

inlinestatic

Parse a message of the given type from the given input stream.

Definition at line 96 of file DynamicMessage.java.

parseFrom() [7/8]

static DynamicMessage com.google.protobuf.DynamicMessage.parseFrom ( Descriptor  type, InputStream  input  ) throws IOException

inlinestatic

Parse a message of the given type from

input 

and return it.

Definition at line 129 of file DynamicMessage.java.

parseFrom() [8/8]

static DynamicMessage com.google.protobuf.DynamicMessage.parseFrom ( Descriptor  type, InputStream  input, ExtensionRegistry  extensionRegistry  ) throws IOException

inlinestatic

Parse a message of the given type from

input 

and return it.

Definition at line 134 of file DynamicMessage.java.

toBuilder()

Builder com.google.protobuf.DynamicMessage.toBuilder ( )

inline

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Implements com.google.protobuf.Message.

Definition at line 278 of file DynamicMessage.java.

verifyContainingType()

void com.google.protobuf.DynamicMessage.verifyContainingType ( FieldDescriptor  field )

inlineprivate

Verifies that the field is a field of this message.

Definition at line 303 of file DynamicMessage.java.

verifyOneofContainingType()

void com.google.protobuf.DynamicMessage.verifyOneofContainingType ( OneofDescriptor  oneof )

inlineprivate

Verifies that the oneof is an oneof of this message.

Definition at line 310 of file DynamicMessage.java.

writeTo()

void com.google.protobuf.DynamicMessage.writeTo ( CodedOutputStream  output ) throws IOException

inline

Serializes the message and writes it to

output 

. This does not flush or close the stream.

Reimplemented from com.google.protobuf.AbstractMessage.

Definition at line 245 of file DynamicMessage.java.

Member Data Documentation

fields

final FieldSet<FieldDescriptor> com.google.protobuf.DynamicMessage.fields

private

Definition at line 53 of file DynamicMessage.java.

memoizedSize

int com.google.protobuf.DynamicMessage.memoizedSize = -1

private

Definition at line 56 of file DynamicMessage.java.

oneofCases

final FieldDescriptor [] com.google.protobuf.DynamicMessage.oneofCases

private

Definition at line 54 of file DynamicMessage.java.

type

final Descriptor com.google.protobuf.DynamicMessage.type

private

Definition at line 52 of file DynamicMessage.java.

unknownFields

final UnknownFieldSet com.google.protobuf.DynamicMessage.unknownFields

private

Definition at line 55 of file DynamicMessage.java.

---

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

• DynamicMessage.java