com.google.protobuf
Interface MessageOrBuilder
- All Superinterfaces:
- MessageLiteOrBuilder
- All Known Subinterfaces:
- DescriptorProtos.DescriptorProto.ExtensionRangeOrBuilder, DescriptorProtos.DescriptorProtoOrBuilder, DescriptorProtos.EnumDescriptorProtoOrBuilder, DescriptorProtos.EnumOptionsOrBuilder, DescriptorProtos.EnumValueDescriptorProtoOrBuilder, DescriptorProtos.EnumValueOptionsOrBuilder, DescriptorProtos.FieldDescriptorProtoOrBuilder, DescriptorProtos.FieldOptionsOrBuilder, DescriptorProtos.FileDescriptorProtoOrBuilder, DescriptorProtos.FileDescriptorSetOrBuilder, DescriptorProtos.FileOptionsOrBuilder, DescriptorProtos.MessageOptionsOrBuilder, DescriptorProtos.MethodDescriptorProtoOrBuilder, DescriptorProtos.MethodOptionsOrBuilder, DescriptorProtos.ServiceDescriptorProtoOrBuilder, DescriptorProtos.ServiceOptionsOrBuilder, DescriptorProtos.SourceCodeInfo.LocationOrBuilder, DescriptorProtos.SourceCodeInfoOrBuilder, DescriptorProtos.UninterpretedOption.NamePartOrBuilder, DescriptorProtos.UninterpretedOptionOrBuilder, GeneratedMessage.ExtendableMessageOrBuilder<MessageType>, Message, Message.Builder
- All Known Implementing Classes:
- AbstractMessage, AbstractMessage.Builder, DescriptorProtos.DescriptorProto, DescriptorProtos.DescriptorProto.Builder, DescriptorProtos.DescriptorProto.ExtensionRange, DescriptorProtos.DescriptorProto.ExtensionRange.Builder, DescriptorProtos.EnumDescriptorProto, DescriptorProtos.EnumDescriptorProto.Builder, DescriptorProtos.EnumOptions, DescriptorProtos.EnumOptions.Builder, DescriptorProtos.EnumValueDescriptorProto, DescriptorProtos.EnumValueDescriptorProto.Builder, DescriptorProtos.EnumValueOptions, DescriptorProtos.EnumValueOptions.Builder, DescriptorProtos.FieldDescriptorProto, DescriptorProtos.FieldDescriptorProto.Builder, DescriptorProtos.FieldOptions, DescriptorProtos.FieldOptions.Builder, DescriptorProtos.FileDescriptorProto, DescriptorProtos.FileDescriptorProto.Builder, DescriptorProtos.FileDescriptorSet, DescriptorProtos.FileDescriptorSet.Builder, DescriptorProtos.FileOptions, DescriptorProtos.FileOptions.Builder, DescriptorProtos.MessageOptions, DescriptorProtos.MessageOptions.Builder, DescriptorProtos.MethodDescriptorProto, DescriptorProtos.MethodDescriptorProto.Builder, DescriptorProtos.MethodOptions, DescriptorProtos.MethodOptions.Builder, DescriptorProtos.ServiceDescriptorProto, DescriptorProtos.ServiceDescriptorProto.Builder, DescriptorProtos.ServiceOptions, DescriptorProtos.ServiceOptions.Builder, DescriptorProtos.SourceCodeInfo, DescriptorProtos.SourceCodeInfo.Builder, DescriptorProtos.SourceCodeInfo.Location, DescriptorProtos.SourceCodeInfo.Location.Builder, DescriptorProtos.UninterpretedOption, DescriptorProtos.UninterpretedOption.Builder, DescriptorProtos.UninterpretedOption.NamePart, DescriptorProtos.UninterpretedOption.NamePart.Builder, DynamicMessage, DynamicMessage.Builder, GeneratedMessage, GeneratedMessage.Builder, GeneratedMessage.ExtendableBuilder, GeneratedMessage.ExtendableMessage
public interface MessageOrBuilder
- extends MessageLiteOrBuilder
Base interface for methods common to Message
and
Message.Builder
to provide type equivalency.
- Author:
- [email protected] (Jon Perlow)
getDefaultInstanceForType
Message getDefaultInstanceForType()
- Description copied from interface:
MessageLiteOrBuilder
- 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.
- Specified by:
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDescriptorForType
Descriptors.Descriptor getDescriptorForType()
- 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.
getAllFields
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. A singular ("required" or "optional")
field is set iff hasField() returns true for that field. A "repeated"
field is set iff getRepeatedFieldSize() 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.
hasField
boolean hasField(Descriptors.FieldDescriptor field)
- Returns true if the given field is set. This is exactly equivalent to
calling the generated "has" accessor method corresponding to the field.
- Throws:
java.lang.IllegalArgumentException
- The field is a repeated field, or
field.getContainingType() != getDescriptorForType()
.
getField
java.lang.Object getField(Descriptors.FieldDescriptor field)
- Obtains 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 returend. For
embedded message fields, the sub-message is returned. For repeated
fields, a java.util.List is returned.
getRepeatedFieldCount
int getRepeatedFieldCount(Descriptors.FieldDescriptor field)
- Gets the number of elements of a repeated field. This is exactly
equivalent to calling the generated "Count" accessor method corresponding
to the field.
- Throws:
java.lang.IllegalArgumentException
- The field is not a repeated field, or
field.getContainingType() != getDescriptorForType()
.
getRepeatedField
java.lang.Object getRepeatedField(Descriptors.FieldDescriptor field,
int index)
- Gets an element of a repeated field. For primitive fields, the boxed
primitive value is returned. For enum fields, the EnumValueDescriptor
for the value is returend. For embedded message fields, the sub-message
is returned.
- Throws:
java.lang.IllegalArgumentException
- The field is not a repeated field, or
field.getContainingType() != getDescriptorForType()
.
getUnknownFields
UnknownFieldSet getUnknownFields()
- Get the
UnknownFieldSet
for this message.
Copyright © 2008-2011 Google. All Rights Reserved.