Package com.google.protobuf
Class DynamicMessage
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.DynamicMessage
- All Implemented Interfaces:
Message,MessageLite,MessageLiteOrBuilder,MessageOrBuilder
An implementation of
Message that can represent arbitrary types, given a Descriptors.Descriptor.-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final FieldSet<Descriptors.FieldDescriptor>private intprivate final Descriptors.FieldDescriptor[]private final Descriptors.Descriptorprivate final UnknownFieldSetFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Constructor Summary
ConstructorsConstructorDescriptionDynamicMessage(Descriptors.Descriptor type, FieldSet<Descriptors.FieldDescriptor> fields, Descriptors.FieldDescriptor[] oneofCases, UnknownFieldSet unknownFields) Construct aDynamicMessageusing the givenFieldSet. -
Method Summary
Modifier and TypeMethodDescriptionReturns a collection of all the fields in this message which are set and their corresponding values.static DynamicMessageGet aDynamicMessagerepresenting the default instance of the given type.Get an instance of the type with no fields set.Get the message's type's descriptor.Obtains the value of the given field, or the default value if it is not set.Obtains the FieldDescriptor if the given oneof is set.Gets the parser for a message of the same type as this message.getRepeatedField(Descriptors.FieldDescriptor field, int index) Gets an element of a repeated field.intGets the number of elements of a repeated field.intGet the number of bytes required to encode this message.Get theUnknownFieldSetfor this message.booleanReturns true if the given field is set.booleanReturns true if the given oneof is set.booleanReturns true if all required fields in the message and all embedded messages are set, false otherwise.(package private) static booleanisInitialized(Descriptors.Descriptor type, FieldSet<Descriptors.FieldDescriptor> fields) static DynamicMessage.BuilderConstruct aMessage.Builderfor the given type.static DynamicMessage.BuildernewBuilder(Message prototype) Construct aMessage.Builderfor a message of the same type asprototype, and initialize it withprototype's contents.Constructs a new builder for a message of the same type as this message.static DynamicMessageparseFrom(Descriptors.Descriptor type, byte[] data) Parsedataas a message of the given type and return it.static DynamicMessageparseFrom(Descriptors.Descriptor type, byte[] data, ExtensionRegistry extensionRegistry) Parsedataas a message of the given type and return it.static DynamicMessageparseFrom(Descriptors.Descriptor type, ByteString data) Parsedataas a message of the given type and return it.static DynamicMessageparseFrom(Descriptors.Descriptor type, ByteString data, ExtensionRegistry extensionRegistry) Parsedataas a message of the given type and return it.static DynamicMessageparseFrom(Descriptors.Descriptor type, CodedInputStream input) Parse a message of the given type from the given input stream.static DynamicMessageparseFrom(Descriptors.Descriptor type, CodedInputStream input, ExtensionRegistry extensionRegistry) Parse a message of the given type from the given input stream.static DynamicMessageparseFrom(Descriptors.Descriptor type, InputStream input) Parse a message of the given type frominputand return it.static DynamicMessageparseFrom(Descriptors.Descriptor type, InputStream input, ExtensionRegistry extensionRegistry) Parse a message of the given type frominputand return it.Constructs a builder initialized with the current message.private voidVerifies that the field is a field of this message.private voidVerifies that the oneof is an oneof of this message.voidwriteTo(CodedOutputStream output) Serializes the message and writes it tooutput.Methods inherited from class com.google.protobuf.AbstractMessage
compareFields, equals, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashBoolean, hashCode, hashEnum, hashEnumList, hashFields, hashLong, newBuilderForType, newUninitializedMessageException, setMemoizedSerializedSize, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, getSerializedSize, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
-
Field Details
-
type
-
fields
-
oneofCases
-
unknownFields
-
memoizedSize
private int memoizedSize
-
-
Constructor Details
-
DynamicMessage
DynamicMessage(Descriptors.Descriptor type, FieldSet<Descriptors.FieldDescriptor> fields, Descriptors.FieldDescriptor[] oneofCases, UnknownFieldSet unknownFields) Construct aDynamicMessageusing the givenFieldSet. oneofCases stores the FieldDescriptor for each oneof to indicate which field is set. Caller should make sure the array is immutable.This constructor is package private and will be used in
DynamicMutableMessageto convert a mutable message to an immutable message.
-
-
Method Details
-
getDefaultInstance
Get aDynamicMessagerepresenting the default instance of the given type. -
parseFrom
public static DynamicMessage parseFrom(Descriptors.Descriptor type, CodedInputStream input) throws IOException Parse a message of the given type from the given input stream.- Throws:
IOException
-
parseFrom
public static DynamicMessage parseFrom(Descriptors.Descriptor type, CodedInputStream input, ExtensionRegistry extensionRegistry) throws IOException Parse a message of the given type from the given input stream.- Throws:
IOException
-
parseFrom
public static DynamicMessage parseFrom(Descriptors.Descriptor type, ByteString data) throws InvalidProtocolBufferException Parsedataas a message of the given type and return it.- Throws:
InvalidProtocolBufferException
-
parseFrom
public static DynamicMessage parseFrom(Descriptors.Descriptor type, ByteString data, ExtensionRegistry extensionRegistry) throws InvalidProtocolBufferException Parsedataas a message of the given type and return it.- Throws:
InvalidProtocolBufferException
-
parseFrom
public static DynamicMessage parseFrom(Descriptors.Descriptor type, byte[] data) throws InvalidProtocolBufferException Parsedataas a message of the given type and return it.- Throws:
InvalidProtocolBufferException
-
parseFrom
public static DynamicMessage parseFrom(Descriptors.Descriptor type, byte[] data, ExtensionRegistry extensionRegistry) throws InvalidProtocolBufferException Parsedataas a message of the given type and return it.- Throws:
InvalidProtocolBufferException
-
parseFrom
public static DynamicMessage parseFrom(Descriptors.Descriptor type, InputStream input) throws IOException Parse a message of the given type frominputand return it.- Throws:
IOException
-
parseFrom
public static DynamicMessage parseFrom(Descriptors.Descriptor type, InputStream input, ExtensionRegistry extensionRegistry) throws IOException Parse a message of the given type frominputand return it.- Throws:
IOException
-
newBuilder
Construct aMessage.Builderfor the given type. -
newBuilder
Construct aMessage.Builderfor a message of the same type asprototype, and initialize it withprototype's contents. -
getDescriptorForType
Description copied from interface:MessageOrBuilderGet the message's type's descriptor. This differs from thegetDescriptor()method of generated message classes in that this method is an abstract method of theMessageinterface whereasgetDescriptor()is a static method of a specific class. They return the same thing. -
getDefaultInstanceForType
Description copied from interface:MessageLiteOrBuilderGet 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 thegetDefaultInstance()method of generated message classes in that this method is an abstract method of theMessageLiteinterface whereasgetDefaultInstance()is a static method of a specific class. They return the same thing. -
getAllFields
Description copied from interface:MessageOrBuilderReturns 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 callingMessageOrBuilder.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. -
hasOneof
Description copied from interface:MessageOrBuilderReturns true if the given oneof is set.- Specified by:
hasOneofin interfaceMessageOrBuilder- Overrides:
hasOneofin classAbstractMessage
-
getOneofFieldDescriptor
Description copied from interface:MessageOrBuilderObtains the FieldDescriptor if the given oneof is set. Returns null if no field is set.- Specified by:
getOneofFieldDescriptorin interfaceMessageOrBuilder- Overrides:
getOneofFieldDescriptorin classAbstractMessage
-
hasField
Description copied from interface:MessageOrBuilderReturns true if the given field is set. This is exactly equivalent to calling the generated "has" accessor method corresponding to the field. The return value of hasField() is semantically meaningful only for fields where field.hasPresence() == true. -
getField
Description copied from interface:MessageOrBuilderObtains the value of the given field, or the default value if it is not set. For primitive fields, the boxed primitive value is returned. For enum fields, the EnumValueDescriptor for the value is returned. For embedded message fields, the sub-message is returned. For repeated fields, a java.util.List is returned. -
getRepeatedFieldCount
Description copied from interface:MessageOrBuilderGets the number of elements of a repeated field. This is exactly equivalent to calling the generated "Count" accessor method corresponding to the field. -
getRepeatedField
Description copied from interface:MessageOrBuilderGets an element of a repeated field. For primitive fields, the boxed primitive value is returned. For enum fields, the EnumValueDescriptor for the value is returned. For embedded message fields, the sub-message is returned. -
getUnknownFields
Description copied from interface:MessageOrBuilderGet theUnknownFieldSetfor this message. -
isInitialized
static boolean isInitialized(Descriptors.Descriptor type, FieldSet<Descriptors.FieldDescriptor> fields) -
isInitialized
public boolean isInitialized()Description copied from interface:MessageLiteOrBuilderReturns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classAbstractMessage
-
writeTo
Description copied from interface:MessageLiteSerializes the message and writes it tooutput. This does not flush or close the stream.- Specified by:
writeToin interfaceMessageLite- Overrides:
writeToin classAbstractMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()Description copied from interface:MessageLiteGet 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.- Specified by:
getSerializedSizein interfaceMessageLite- Overrides:
getSerializedSizein classAbstractMessage
-
newBuilderForType
Description copied from interface:MessageLiteConstructs a new builder for a message of the same type as this message. -
toBuilder
Description copied from interface:MessageLiteConstructs a builder initialized with the current message. Use this to derive a new message from the current one. -
getParserForType
Description copied from interface:MessageLiteGets the parser for a message of the same type as this message. -
verifyContainingType
Verifies that the field is a field of this message. -
verifyOneofContainingType
Verifies that the oneof is an oneof of this message.
-