Class GeneratedMessage

public abstract class GeneratedMessage extends AbstractMessage implements Serializable

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.

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage

Implements

Serializable

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

AbstractMessage.getSerializedSize()

AbstractMessage.hasOneof(Descriptors.OneofDescriptor)

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.isInitialized()

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessage.writeTo(CodedOutputStream)

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

alwaysUseFieldBuilders

protected static boolean alwaysUseFieldBuilders

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.

Field Value

Type	Description
boolean

Static Methods

<ContainingType,Type>newFileScopedGeneratedExtension(Class singularType, Message defaultInstance)

public static GeneratedMessage.GeneratedExtension<ContainingType,Type> <ContainingType,Type>newFileScopedGeneratedExtension(Class singularType, Message defaultInstance)

For use by generated code only.

Parameters

Name	Description
singularType	Class
defaultInstance	Message

Returns

Type	Description
GeneratedExtension<ContainingType,Type>

<ContainingType,Type>newFileScopedGeneratedExtension(Class singularType, Message defaultInstance, String descriptorOuterClass, String extensionName)

public static GeneratedMessage.GeneratedExtension<ContainingType,Type> <ContainingType,Type>newFileScopedGeneratedExtension(Class singularType, Message defaultInstance, String descriptorOuterClass, String extensionName)

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.

Parameters

Name	Description
singularType	Class
defaultInstance	Message
descriptorOuterClass	String
extensionName	String

Returns

Type	Description
GeneratedExtension<ContainingType,Type>

<ContainingType,Type>newMessageScopedGeneratedExtension(Message scope, int descriptorIndex, Class singularType, Message defaultInstance)

public static GeneratedMessage.GeneratedExtension<ContainingType,Type> <ContainingType,Type>newMessageScopedGeneratedExtension(Message scope, int descriptorIndex, Class singularType, Message defaultInstance)

For use by generated code only.

Parameters

Name	Description
scope	Message
descriptorIndex	int
singularType	Class
defaultInstance	Message

Returns

Type	Description
GeneratedExtension<ContainingType,Type>

<ContainingType,Type>newMessageScopedGeneratedExtension(Message scope, String name, Class singularType, Message defaultInstance)

public static GeneratedMessage.GeneratedExtension<ContainingType,Type> <ContainingType,Type>newMessageScopedGeneratedExtension(Message scope, String name, Class singularType, Message defaultInstance)

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.

Parameters

Name	Description
scope	Message
name	String
singularType	Class
defaultInstance	Message

Returns

Type	Description
GeneratedExtension<ContainingType,Type>

<M>parseDelimitedWithIOException(Parser<M> parser, InputStream input)

protected static M <M>parseDelimitedWithIOException(Parser<M> parser, InputStream input)

Parameters

Name	Description
parser	Parser<M>
input	InputStream

Returns

Type	Description
M

Exceptions

Type	Description
IOException

<M>parseDelimitedWithIOException(Parser<M> parser, InputStream input, ExtensionRegistryLite extensions)

protected static M <M>parseDelimitedWithIOException(Parser<M> parser, InputStream input, ExtensionRegistryLite extensions)

Parameters

Name	Description
parser	Parser<M>
input	InputStream
extensions	ExtensionRegistryLite

Returns

Type	Description
M

Exceptions

Type	Description
IOException

<M>parseWithIOException(Parser<M> parser, CodedInputStream input)

protected static M <M>parseWithIOException(Parser<M> parser, CodedInputStream input)

Parameters

Name	Description
parser	Parser<M>
input	CodedInputStream

Returns

Type	Description
M

Exceptions

Type	Description
IOException

<M>parseWithIOException(Parser<M> parser, CodedInputStream input, ExtensionRegistryLite extensions)

protected static M <M>parseWithIOException(Parser<M> parser, CodedInputStream input, ExtensionRegistryLite extensions)

Parameters

Name	Description
parser	Parser<M>
input	CodedInputStream
extensions	ExtensionRegistryLite

Returns

Type	Description
M

Exceptions

Type	Description
IOException

<M>parseWithIOException(Parser<M> parser, InputStream input)

protected static M <M>parseWithIOException(Parser<M> parser, InputStream input)

Parameters

Name	Description
parser	Parser<M>
input	InputStream

Returns

Type	Description
M

Exceptions

Type	Description
IOException

<M>parseWithIOException(Parser<M> parser, InputStream input, ExtensionRegistryLite extensions)

protected static M <M>parseWithIOException(Parser<M> parser, InputStream input, ExtensionRegistryLite extensions)

Parameters

Name	Description
parser	Parser<M>
input	InputStream
extensions	ExtensionRegistryLite

Returns

Type	Description
M

Exceptions

Type	Description
IOException

computeStringSize(int fieldNumber, Object value)

protected static int computeStringSize(int fieldNumber, Object value)

Parameters

Name	Description
fieldNumber	int
value	Object

Returns

Type	Description
int

computeStringSizeNoTag(Object value)

protected static int computeStringSizeNoTag(Object value)

Parameter

Name	Description
value	Object

Returns

Type	Description
int

writeString(CodedOutputStream output, int fieldNumber, Object value)

protected static void writeString(CodedOutputStream output, int fieldNumber, Object value)

Parameters

Name	Description
output	CodedOutputStream
fieldNumber	int
value	Object

Exceptions

Type	Description
IOException

writeStringNoTag(CodedOutputStream output, Object value)

protected static void writeStringNoTag(CodedOutputStream output, Object value)

Parameters

Name	Description
output	CodedOutputStream
value	Object

Exceptions

Type	Description
IOException

Constructors

GeneratedMessage()

protected GeneratedMessage()

GeneratedMessage(GeneratedMessage.Builder<?> builder)

protected GeneratedMessage(GeneratedMessage.Builder<?> builder)

Parameter

Name	Description
builder	Builder<?>

Fields

unknownFields

protected UnknownFieldSet unknownFields

For use by generated code only.

Field Value

Type	Description
UnknownFieldSet

Methods

getAllFields()

public Map<Descriptors.FieldDescriptor,Object> getAllFields()

Returns

Type	Description
Map<FieldDescriptor,Object>

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptors.Descriptor

getField(Descriptors.FieldDescriptor field)

public Object getField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	Descriptors.FieldDescriptor

Returns

Type	Description
Object

getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)

public Descriptors.FieldDescriptor getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)

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

Parameter

Name	Description
oneof	Descriptors.OneofDescriptor

Returns

Type	Description
Descriptors.FieldDescriptor

Overrides

AbstractMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)

getParserForType()

public Parser<? extends GeneratedMessage> getParserForType()

Returns

Type	Description
Parser<? extends com.google.protobuf.GeneratedMessage>

getRepeatedField(Descriptors.FieldDescriptor field, int index)

public Object getRepeatedField(Descriptors.FieldDescriptor field, int index)

Parameters

Name	Description
field	Descriptors.FieldDescriptor
index	int

Returns

Type	Description
Object

getRepeatedFieldCount(Descriptors.FieldDescriptor field)

public int getRepeatedFieldCount(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	Descriptors.FieldDescriptor

Returns

Type	Description
int

getSerializedSize()

public int getSerializedSize()

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

If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.

Returns

Type	Description
int

Overrides

AbstractMessage.getSerializedSize()

getUnknownFields()

public UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

hasField(Descriptors.FieldDescriptor field)

public boolean hasField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	Descriptors.FieldDescriptor

Returns

Type	Description
boolean

hasOneof(Descriptors.OneofDescriptor oneof)

public boolean hasOneof(Descriptors.OneofDescriptor oneof)

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

Parameter

Name	Description
oneof	Descriptors.OneofDescriptor

Returns

Type	Description
boolean

Overrides

AbstractMessage.hasOneof(Descriptors.OneofDescriptor oneof)

internalGetFieldAccessorTable()

protected abstract GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

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.

Returns

Type	Description
GeneratedMessage.FieldAccessorTable

internalGetMapField(int fieldNumber)

protected MapField internalGetMapField(int fieldNumber)

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.

Parameter

Name	Description
fieldNumber	int

Returns

Type	Description
MapField

isInitialized()

public boolean isInitialized()

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

See also: MessageOrBuilder#getInitializationErrorString()

Returns

Type	Description
boolean

Overrides

AbstractMessage.isInitialized()

makeExtensionsImmutable()

protected void makeExtensionsImmutable()

Used by parsing constructors in generated classes.

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Message.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Create a nested builder.

Parameter

Name	Description
parent	AbstractMessage.BuilderParent

Returns

Type	Description
Message.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

newBuilderForType(GeneratedMessage.BuilderParent parent)

protected abstract Message.Builder newBuilderForType(GeneratedMessage.BuilderParent parent)

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

Parameter

Name	Description
parent	GeneratedMessage.BuilderParent

Returns

Type	Description
Message.Builder

parseUnknownField(CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag)

protected boolean parseUnknownField(CodedInputStream input, UnknownFieldSet.Builder unknownFields, ExtensionRegistryLite extensionRegistry, int tag)

Called by subclasses to parse an unknown field.

Parameters

Name	Description
input	CodedInputStream
unknownFields	UnknownFieldSet.Builder
extensionRegistry	ExtensionRegistryLite
tag	int

Returns

Type	Description
boolean	true unless the tag is an end-group tag.

Exceptions

Type	Description
IOException

writeReplace()

protected Object writeReplace()

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

Type	Description
Object	a SerializedForm of this message

Exceptions

Type	Description
ObjectStreamException

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Serializes the message and writes it to output. This does not flush or close the stream.

Parameter

Name	Description
output	CodedOutputStream

Overrides

AbstractMessage.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException