|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
public abstract class GeneratedMessage
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.
| Nested Class Summary | |
|---|---|
static class |
GeneratedMessage.Builder<BuilderType extends GeneratedMessage.Builder>
|
protected static interface |
GeneratedMessage.BuilderParent
Interface for the parent of a Builder that allows the builder to communicate invalidations back to the parent for use when using nested builders. |
static class |
GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder>
Generated message builders for message types that contain extension ranges subclass this. |
static class |
GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>
Generated message classes for message types that contain extension ranges subclass this. |
static interface |
GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>
|
static class |
GeneratedMessage.FieldAccessorTable
Users should ignore this class. |
static class |
GeneratedMessage.GeneratedExtension<ContainingType extends Message,Type>
Type used to represent generated extensions. |
| Field Summary | |
|---|---|
protected static boolean |
alwaysUseFieldBuilders
For testing. |
| Constructor Summary | |
|---|---|
protected |
GeneratedMessage()
|
protected |
GeneratedMessage(GeneratedMessage.Builder<?> builder)
|
| Method Summary | ||
|---|---|---|
java.util.Map<Descriptors.FieldDescriptor,java.lang.Object> |
getAllFields()
Returns a collection of all the fields in this message which are set and their corresponding values. |
|
Descriptors.Descriptor |
getDescriptorForType()
Get the message's type's descriptor. |
|
java.lang.Object |
getField(Descriptors.FieldDescriptor field)
Obtains the value of the given field, or the default value if it is not set. |
|
java.lang.Object |
getRepeatedField(Descriptors.FieldDescriptor field,
int index)
Gets an element of a repeated field. |
|
int |
getRepeatedFieldCount(Descriptors.FieldDescriptor field)
Gets the number of elements of a repeated field. |
|
UnknownFieldSet |
getUnknownFields()
Get the UnknownFieldSet for this message. |
|
boolean |
hasField(Descriptors.FieldDescriptor field)
Returns true if the given field is set. |
|
protected abstract GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type. |
|
boolean |
isInitialized()
Returns true if all required fields in the message and all embedded messages are set, false otherwise. |
|
protected abstract Message.Builder |
newBuilderForType(GeneratedMessage.BuilderParent parent)
|
|
static
|
newFileScopedGeneratedExtension(java.lang.Class singularType,
Message defaultInstance)
For use by generated code only. |
|
static
|
newMessageScopedGeneratedExtension(Message scope,
int descriptorIndex,
java.lang.Class singularType,
Message defaultInstance)
For use by generated code only. |
|
protected java.lang.Object |
writeReplace()
Replaces this object in the output stream with a serialized form. |
|
| Methods inherited from class com.google.protobuf.AbstractMessage |
|---|
equals, getSerializedSize, hashBoolean, hashCode, hashEnum, hashEnumList, hashFields, hashLong, toString, writeTo |
| Methods inherited from class com.google.protobuf.AbstractMessageLite |
|---|
toByteArray, toByteString, writeDelimitedTo, writeTo |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.google.protobuf.Message |
|---|
newBuilderForType, toBuilder |
| Methods inherited from interface com.google.protobuf.MessageLite |
|---|
toByteArray, toByteString, writeDelimitedTo, writeTo |
| Methods inherited from interface com.google.protobuf.MessageOrBuilder |
|---|
getDefaultInstanceForType |
| Field Detail |
|---|
protected static boolean alwaysUseFieldBuilders
| Constructor Detail |
|---|
protected GeneratedMessage()
protected GeneratedMessage(GeneratedMessage.Builder<?> builder)
| Method Detail |
|---|
protected abstract GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
public Descriptors.Descriptor getDescriptorForType()
MessageOrBuildergetDescriptor() 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.
getDescriptorForType in interface MessageOrBuilderpublic boolean isInitialized()
MessageLiteOrBuilder
isInitialized in interface MessageLiteOrBuilderisInitialized in class AbstractMessagepublic java.util.Map<Descriptors.FieldDescriptor,java.lang.Object> getAllFields()
MessageOrBuilderMessageOrBuilder.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.
getAllFields in interface MessageOrBuilderpublic boolean hasField(Descriptors.FieldDescriptor field)
MessageOrBuilder
hasField in interface MessageOrBuilderpublic java.lang.Object getField(Descriptors.FieldDescriptor field)
MessageOrBuilder
getField in interface MessageOrBuilderpublic int getRepeatedFieldCount(Descriptors.FieldDescriptor field)
MessageOrBuilder
getRepeatedFieldCount in interface MessageOrBuilder
public java.lang.Object getRepeatedField(Descriptors.FieldDescriptor field,
int index)
MessageOrBuilder
getRepeatedField in interface MessageOrBuilderpublic final UnknownFieldSet getUnknownFields()
MessageOrBuilderUnknownFieldSet for this message.
getUnknownFields in interface MessageOrBuilderprotected abstract Message.Builder newBuilderForType(GeneratedMessage.BuilderParent parent)
public static <ContainingType extends Message,Type> GeneratedMessage.GeneratedExtension<ContainingType,Type> newMessageScopedGeneratedExtension(Message scope,
int descriptorIndex,
java.lang.Class singularType,
Message defaultInstance)
public static <ContainingType extends Message,Type> GeneratedMessage.GeneratedExtension<ContainingType,Type> newFileScopedGeneratedExtension(java.lang.Class singularType,
Message defaultInstance)
protected java.lang.Object writeReplace()
throws java.io.ObjectStreamException
return super.writeReplace();
java.io.ObjectStreamException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||