com.google.protobuf.GeneratedMessage Class Reference

Inheritance diagram for com.google.protobuf.GeneratedMessage:

Classes
class	Builder
interface	BuilderParent
class	CachedDescriptorRetriever
class	ExtendableBuilder
class	ExtendableMessage
interface	ExtendableMessageOrBuilder
interface	ExtensionDescriptorRetriever
class	FieldAccessorTable
class	GeneratedExtension

Public Member Functions
Map< FieldDescriptor, Object >	getAllFields ()
Descriptor	getDescriptorForType ()
Object	getField (final FieldDescriptor field)
FieldDescriptor	getOneofFieldDescriptor (final OneofDescriptor oneof)
Parser<? extends GeneratedMessage >	getParserForType ()
Object	getRepeatedField (final FieldDescriptor field, final int index)
int	getRepeatedFieldCount (final FieldDescriptor field)
int	getSerializedSize ()
UnknownFieldSet	getUnknownFields ()
boolean	hasField (final FieldDescriptor field)
boolean	hasOneof (final OneofDescriptor oneof)
boolean	isInitialized ()
void	writeTo (final 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.Message
Builder	newBuilderForType ()
Builder	toBuilder ()
Public Member Functions inherited from com.google.protobuf.MessageOrBuilder
Message	getDefaultInstanceForType ()
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< ContainingType extends Message, Type > GeneratedExtension< ContainingType, Type >	newFileScopedGeneratedExtension (final Class singularType, final Message defaultInstance)
static< ContainingType extends Message, Type > GeneratedExtension< ContainingType, Type >	newFileScopedGeneratedExtension (final Class singularType, final Message defaultInstance, final String descriptorOuterClass, final String extensionName)
static< ContainingType extends Message, Type > GeneratedExtension< ContainingType, Type >	newMessageScopedGeneratedExtension (final Message scope, final int descriptorIndex, final Class singularType, final Message defaultInstance)
static< ContainingType extends Message, Type > GeneratedExtension< ContainingType, Type >	newMessageScopedGeneratedExtension (final Message scope, final String name, final Class singularType, final Message defaultInstance)

Protected Member Functions
	GeneratedMessage ()
	GeneratedMessage (Builder<?> builder)
abstract FieldAccessorTable	internalGetFieldAccessorTable ()
MapField	internalGetMapField (int fieldNumber)
void	makeExtensionsImmutable ()
abstract Message.Builder	newBuilderForType (BuilderParent parent)
Message.Builder	newBuilderForType (final AbstractMessage.BuilderParent parent)
boolean	parseUnknownField (CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag) throws IOException
Object	writeReplace () throws ObjectStreamException
Protected Member Functions inherited from com.google.protobuf.AbstractMessage
Message.Builder	newBuilderForType (BuilderParent parent)

Static Protected Member Functions
static int	computeStringSize (final int fieldNumber, final Object value)
static int	computeStringSizeNoTag (final Object value)
static< M extends Message > M	parseDelimitedWithIOException (Parser< M > parser, InputStream input) throws IOException
static< M extends Message > M	parseDelimitedWithIOException (Parser< M > parser, InputStream input, ExtensionRegistryLite extensions) throws IOException
static< M extends Message > M	parseWithIOException (Parser< M > parser, CodedInputStream input) throws IOException
static< M extends Message > M	parseWithIOException (Parser< M > parser, CodedInputStream input, ExtensionRegistryLite extensions) throws IOException
static< M extends Message > M	parseWithIOException (Parser< M > parser, InputStream input) throws IOException
static< M extends Message > M	parseWithIOException (Parser< M > parser, InputStream input, ExtensionRegistryLite extensions) throws IOException
static void	writeString (CodedOutputStream output, final int fieldNumber, final Object value) throws IOException
static void	writeStringNoTag (CodedOutputStream output, final Object value) throws IOException
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
UnknownFieldSet	unknownFields
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

Static Protected Attributes
static boolean	alwaysUseFieldBuilders = false

Private Member Functions
Map< FieldDescriptor, Object >	getAllFieldsMutable (boolean getBytesForString)

Static Private Member Functions
static< MessageType extends ExtendableMessage< MessageType > T Extension< MessageType, T >	checkNotLite (ExtensionLite< MessageType, T > extension)
static Method	getMethodOrDie (final Class clazz, final String name, final Class... params)
static Object	invokeOrDie (final Method method, final Object object, final Object... params)

Static Private Attributes
static final long	serialVersionUID = 1L

Detailed Description

All generated protocol message classes extend this class. This class implements most of the Message and Builder interfaces using Java reflection. Users can ignore this class and pretend that generated messages implement the Message interface directly.

Author

kento.nosp@m.n@go.nosp@m.ogle..nosp@m.com Kenton Varda

Definition at line 61 of file GeneratedMessage.java.

Constructor & Destructor Documentation

GeneratedMessage() [1/2]

com.google.protobuf.GeneratedMessage.GeneratedMessage ( )

inlineprotected

Definition at line 75 of file GeneratedMessage.java.

GeneratedMessage() [2/2]

com.google.protobuf.GeneratedMessage.GeneratedMessage ( Builder<?>  builder )

inlineprotected

Definition at line 79 of file GeneratedMessage.java.

Member Function Documentation

checkNotLite()

static <MessageType extends ExtendableMessage<MessageType> T Extension<MessageType, T> com.google.protobuf.GeneratedMessage.checkNotLite ( ExtensionLite< MessageType, T >  extension )

inlinestaticprivate

Definition at line 3009 of file GeneratedMessage.java.

computeStringSize()

static int com.google.protobuf.GeneratedMessage.computeStringSize ( final int  fieldNumber, final Object  value  )

inlinestaticprotected

Definition at line 3018 of file GeneratedMessage.java.

computeStringSizeNoTag()

static int com.google.protobuf.GeneratedMessage.computeStringSizeNoTag ( final Object  value )

inlinestaticprotected

Definition at line 3026 of file GeneratedMessage.java.

getAllFields()

Map<FieldDescriptor, Object> com.google.protobuf.GeneratedMessage.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.

Reimplemented in com.google.protobuf.GeneratedMessage.ExtendableMessage< MessageType extends ExtendableMessage >.

Definition at line 196 of file GeneratedMessage.java.

getAllFieldsMutable()

Map<FieldDescriptor, Object> com.google.protobuf.GeneratedMessage.getAllFieldsMutable ( boolean  getBytesForString )

inlineprivate

Internal helper to return a modifiable map containing all the fields. The returned Map is modifialbe so that the caller can add additional extension fields to implement getAllFields().

Parameters

getBytesForString

whether to generate ByteString for string fields

Definition at line 118 of file GeneratedMessage.java.

getDescriptorForType()

Descriptor com.google.protobuf.GeneratedMessage.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 107 of file GeneratedMessage.java.

getField()

Object com.google.protobuf.GeneratedMessage.getField ( final FieldDescriptor  field )

inline

Reimplemented in com.google.protobuf.GeneratedMessage.ExtendableMessage< MessageType extends ExtendableMessage >.

Definition at line 232 of file GeneratedMessage.java.

getMethodOrDie()

static Method com.google.protobuf.GeneratedMessage.getMethodOrDie ( final Class  clazz, final String  name, final Class...  params  )

inlinestaticprivate

Calls Class.getMethod and throws a RuntimeException if it fails.

Definition at line 1967 of file GeneratedMessage.java.

getOneofFieldDescriptor()

FieldDescriptor com.google.protobuf.GeneratedMessage.getOneofFieldDescriptor ( final OneofDescriptor  oneof )

inline

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

Reimplemented from com.google.protobuf.AbstractMessage.

Definition at line 222 of file GeneratedMessage.java.

getParserForType()

Parser<? extends GeneratedMessage> com.google.protobuf.GeneratedMessage.getParserForType ( )

inline

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

Implements com.google.protobuf.Message.

Reimplemented in com.google.protobuf.jruby.SentinelOuterClass.Sentinel.

Definition at line 84 of file GeneratedMessage.java.

getRepeatedField()

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

inline

Reimplemented in com.google.protobuf.GeneratedMessage.ExtendableMessage< MessageType extends ExtendableMessage >.

Definition at line 255 of file GeneratedMessage.java.

getRepeatedFieldCount()

int com.google.protobuf.GeneratedMessage.getRepeatedFieldCount ( final FieldDescriptor  field )

inline

Reimplemented in com.google.protobuf.GeneratedMessage.ExtendableMessage< MessageType extends ExtendableMessage >.

Definition at line 249 of file GeneratedMessage.java.

getSerializedSize()

int com.google.protobuf.GeneratedMessage.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 338 of file GeneratedMessage.java.

getUnknownFields()

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

inline

Get the UnknownFieldSet for this message.

Implements com.google.protobuf.MessageOrBuilder.

Reimplemented in com.google.protobuf.jruby.SentinelOuterClass.Sentinel.

Definition at line 261 of file GeneratedMessage.java.

hasField()

boolean com.google.protobuf.GeneratedMessage.hasField ( final FieldDescriptor  field )

inline

Reimplemented in com.google.protobuf.GeneratedMessage.ExtendableMessage< MessageType extends ExtendableMessage >.

Definition at line 227 of file GeneratedMessage.java.

hasOneof()

boolean com.google.protobuf.GeneratedMessage.hasOneof ( final OneofDescriptor  oneof )

inline

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

Reimplemented from com.google.protobuf.AbstractMessage.

Definition at line 217 of file GeneratedMessage.java.

internalGetFieldAccessorTable()

abstract FieldAccessorTable com.google.protobuf.GeneratedMessage.internalGetFieldAccessorTable ( )

abstractprotected

Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.

Reimplemented in com.google.protobuf.jruby.SentinelOuterClass.Sentinel.

internalGetMapField()

MapField com.google.protobuf.GeneratedMessage.internalGetMapField ( int  fieldNumber )

inlineprotected

Gets the map field with the given field number. This method should be overridden in the generated message class if the message contains map fields.

Unlike other field types, reflection support for map fields can't be implemented based on generated public API because we need to access a map field as a list in reflection API but the generated API only allows us to access it as a map. This method returns the underlying map field directly and thus enables us to access the map field as a list.

Definition at line 2012 of file GeneratedMessage.java.

invokeOrDie()

static Object com.google.protobuf.GeneratedMessage.invokeOrDie ( final Method  method, final Object  object, final Object...  params  )

inlinestaticprivate

Calls invoke and throws a RuntimeException if it fails.

Definition at line 1979 of file GeneratedMessage.java.

isInitialized()

boolean com.google.protobuf.GeneratedMessage.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.

Reimplemented in com.google.protobuf.GeneratedMessage.ExtendableMessage< MessageType extends ExtendableMessage >.

Definition at line 166 of file GeneratedMessage.java.

makeExtensionsImmutable()

void com.google.protobuf.GeneratedMessage.makeExtensionsImmutable ( )

inlineprotected

Used by parsing constructors in generated classes.

Reimplemented in com.google.protobuf.GeneratedMessage.ExtendableMessage< MessageType extends ExtendableMessage >.

Definition at line 354 of file GeneratedMessage.java.

newBuilderForType() [1/2]

abstract Message.Builder com.google.protobuf.GeneratedMessage.newBuilderForType ( BuilderParent  parent )

abstractprotected

TODO(xiaofeng): remove this together with GeneratedMessage.BuilderParent.

newBuilderForType() [2/2]

Message.Builder com.google.protobuf.GeneratedMessage.newBuilderForType ( final AbstractMessage.BuilderParent  parent )

inlineprotected

Definition at line 372 of file GeneratedMessage.java.

newFileScopedGeneratedExtension() [1/2]

static <ContainingType extends Message, Type> GeneratedExtension<ContainingType, Type> com.google.protobuf.GeneratedMessage.newFileScopedGeneratedExtension ( final Class  singularType, final Message  defaultInstance  )

inlinestatic

For use by generated code only.

Definition at line 1638 of file GeneratedMessage.java.

newFileScopedGeneratedExtension() [2/2]

static <ContainingType extends Message, Type> GeneratedExtension<ContainingType, Type> com.google.protobuf.GeneratedMessage.newFileScopedGeneratedExtension ( final Class  singularType, final Message  defaultInstance, final String  descriptorOuterClass, final String  extensionName  )

inlinestatic

Used in proto1 generated code only.

After enabling bridge, we can define proto2 extensions (the extended type is a proto2 mutable message) in a proto1 .proto file. For these extensions we should generate proto2 GeneratedExtensions.

Definition at line 1704 of file GeneratedMessage.java.

newMessageScopedGeneratedExtension() [1/2]

static <ContainingType extends Message, Type> GeneratedExtension<ContainingType, Type> com.google.protobuf.GeneratedMessage.newMessageScopedGeneratedExtension ( final Message  scope, final int  descriptorIndex, final Class  singularType, final Message  defaultInstance  )

inlinestatic

For use by generated code only.

Definition at line 1616 of file GeneratedMessage.java.

newMessageScopedGeneratedExtension() [2/2]

static <ContainingType extends Message, Type> GeneratedExtension<ContainingType, Type> com.google.protobuf.GeneratedMessage.newMessageScopedGeneratedExtension ( final Message  scope, final String  name, final Class  singularType, final Message  defaultInstance  )

inlinestatic

Used in proto1 generated code only.

After enabling bridge, we can define proto2 extensions (the extended type is a proto2 mutable message) in a proto1 .proto file. For these extensions we should generate proto2 GeneratedExtensions.

Definition at line 1677 of file GeneratedMessage.java.

parseDelimitedWithIOException() [1/2]

static <M extends Message> M com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException ( Parser< M >  parser, InputStream  input  ) throws IOException

inlinestaticprotected

Definition at line 314 of file GeneratedMessage.java.

parseDelimitedWithIOException() [2/2]

static <M extends Message> M com.google.protobuf.GeneratedMessage.parseDelimitedWithIOException ( Parser< M >  parser, InputStream  input, ExtensionRegistryLite  extensions  ) throws IOException

inlinestaticprotected

Definition at line 323 of file GeneratedMessage.java.

parseUnknownField()

boolean com.google.protobuf.GeneratedMessage.parseUnknownField ( CodedInputStream  input, UnknownFieldSet.Builder  unknownFields, ExtensionRegistryLite  extensionRegistry, int  tag  ) throws IOException

inlineprotected

Called by subclasses to parse an unknown field.

Returns

true 

unless the tag is an end-group tag.

Definition at line 270 of file GeneratedMessage.java.

parseWithIOException() [1/4]

static <M extends Message> M com.google.protobuf.GeneratedMessage.parseWithIOException ( Parser< M >  parser, CodedInputStream  input  ) throws IOException

inlinestaticprotected

Definition at line 296 of file GeneratedMessage.java.

parseWithIOException() [2/4]

static <M extends Message> M com.google.protobuf.GeneratedMessage.parseWithIOException ( Parser< M >  parser, CodedInputStream  input, ExtensionRegistryLite  extensions  ) throws IOException

inlinestaticprotected

Definition at line 305 of file GeneratedMessage.java.

parseWithIOException() [3/4]

static <M extends Message> M com.google.protobuf.GeneratedMessage.parseWithIOException ( Parser< M >  parser, InputStream  input  ) throws IOException

inlinestaticprotected

Definition at line 278 of file GeneratedMessage.java.

parseWithIOException() [4/4]

static <M extends Message> M com.google.protobuf.GeneratedMessage.parseWithIOException ( Parser< M >  parser, InputStream  input, ExtensionRegistryLite  extensions  ) throws IOException

inlinestaticprotected

Definition at line 287 of file GeneratedMessage.java.

writeReplace()

Object com.google.protobuf.GeneratedMessage.writeReplace ( ) throws ObjectStreamException

inlineprotected

Replaces this object in the output stream with a serialized form. Part of Java's serialization magic. Generated sub-classes must override this method by calling

return super.writeReplace(); 

Returns

a SerializedForm of this message

Definition at line 3000 of file GeneratedMessage.java.

writeString()

static void com.google.protobuf.GeneratedMessage.writeString ( CodedOutputStream  output, final int  fieldNumber, final Object  value  ) throws IOException

inlinestaticprotected

Definition at line 3034 of file GeneratedMessage.java.

writeStringNoTag()

static void com.google.protobuf.GeneratedMessage.writeStringNoTag ( CodedOutputStream  output, final Object  value  ) throws IOException

inlinestaticprotected

Definition at line 3043 of file GeneratedMessage.java.

writeTo()

void com.google.protobuf.GeneratedMessage.writeTo ( final 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 333 of file GeneratedMessage.java.

Member Data Documentation

alwaysUseFieldBuilders

boolean com.google.protobuf.GeneratedMessage.alwaysUseFieldBuilders = false

staticprotected

For testing. Allows a test to disable the optimization that avoids using field builders for nested messages until they are requested. By disabling this optimization, existing tests can be reused to test the field builders.

Definition at line 70 of file GeneratedMessage.java.

serialVersionUID

final long com.google.protobuf.GeneratedMessage.serialVersionUID = 1L

staticprivate

Definition at line 63 of file GeneratedMessage.java.

unknownFields

UnknownFieldSet com.google.protobuf.GeneratedMessage.unknownFields

protected

For use by generated code only.

Definition at line 73 of file GeneratedMessage.java.

---

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

• GeneratedMessage.java