Top Description Methods
com.google.protobuf

public Interface MessageOrBuilder

extends MessageLiteOrBuilder
Known Direct Subinterfaces
com.google.protobuf.MethodOrBuilder, com.google.protobuf.MixinOrBuilder, com.google.protobuf.OptionOrBuilder, com.google.protobuf.SourceContextOrBuilder, com.google.protobuf.StringValueOrBuilder, com.google.protobuf.StructOrBuilder, com.google.protobuf.EmptyOrBuilder, com.google.protobuf.EnumOrBuilder, com.google.protobuf.EnumValueOrBuilder, com.google.protobuf.FieldMaskOrBuilder, com.google.protobuf.FieldOrBuilder, com.google.protobuf.FloatValueOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder, com.google.protobuf.Int32ValueOrBuilder, com.google.protobuf.Int64ValueOrBuilder, com.google.protobuf.ListValueOrBuilder, com.google.protobuf.TimestampOrBuilder, com.google.protobuf.TypeOrBuilder, com.google.protobuf.UInt32ValueOrBuilder, com.google.protobuf.UInt64ValueOrBuilder, com.google.protobuf.ValueOrBuilder, com.google.protobuf.BytesValueOrBuilder, com.google.protobuf.DescriptorProtos.FileDescriptorSetOrBuilder, com.google.protobuf.DescriptorProtos.FileDescriptorProtoOrBuilder, com.google.protobuf.DescriptorProtos.DescriptorProtoOrBuilder, com.google.protobuf.DescriptorProtos.DescriptorProto.ExtensionRangeOrBuilder, com.google.protobuf.DescriptorProtos.DescriptorProto.ReservedRangeOrBuilder, com.google.protobuf.DescriptorProtos.FieldDescriptorProtoOrBuilder, com.google.protobuf.DescriptorProtos.OneofDescriptorProtoOrBuilder, com.google.protobuf.DescriptorProtos.EnumDescriptorProtoOrBuilder, com.google.protobuf.DescriptorProtos.EnumDescriptorProto.EnumReservedRangeOrBuilder, com.google.protobuf.DescriptorProtos.EnumValueDescriptorProtoOrBuilder, com.google.protobuf.DescriptorProtos.ServiceDescriptorProtoOrBuilder, com.google.protobuf.DescriptorProtos.MethodDescriptorProtoOrBuilder, com.google.protobuf.DescriptorProtos.UninterpretedOptionOrBuilder, com.google.protobuf.DescriptorProtos.UninterpretedOption.NamePartOrBuilder, com.google.protobuf.DescriptorProtos.SourceCodeInfoOrBuilder, com.google.protobuf.DescriptorProtos.SourceCodeInfo.LocationOrBuilder, com.google.protobuf.DescriptorProtos.GeneratedCodeInfoOrBuilder, com.google.protobuf.DescriptorProtos.GeneratedCodeInfo.AnnotationOrBuilder, com.google.protobuf.DoubleValueOrBuilder, com.google.protobuf.DurationOrBuilder, com.google.protobuf.compiler.PluginProtos.VersionOrBuilder, com.google.protobuf.compiler.PluginProtos.CodeGeneratorRequestOrBuilder, com.google.protobuf.compiler.PluginProtos.CodeGeneratorResponseOrBuilder, com.google.protobuf.compiler.PluginProtos.CodeGeneratorResponse.FileOrBuilder, com.google.protobuf.AnyOrBuilder, com.google.protobuf.ApiOrBuilder, com.google.protobuf.BoolValueOrBuilder, com.google.protobuf.Message, com.google.protobuf.Message.Builder
Imports
java.util.List, .Map

Base interface for methods common to Message and Message.Builder to provide type equivalency.
Author
[email protected] (Jon Perlow)

Method Summary

Modifier and TypeMethod and Description
public List<String>
findInitializationErrors()

Returns a list of field paths (e.g. "foo.bar.baz") of required fields which are not set in this message.

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

Returns a collection of all the fields in this message which are set and their corresponding values.

public Message
getDefaultInstanceForType()

Redeclares com.google.protobuf.MessageLiteOrBuilder.getDefaultInstanceForType.

Get an instance of the type with no fields set.
public Descriptors.Descriptor
getDescriptorForType()

Get the message's type's descriptor.

public Object
getField(Descriptors.FieldDescriptor field)

Obtains the value of the given field, or the default value if it is not set.

public String
getInitializationErrorString()

Returns a comma-delimited list of required fields which are not set in this message object.

public Descriptors.FieldDescriptor
getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)

Obtains the FieldDescriptor if the given oneof is set.

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

Gets an element of a repeated field.

public int
getRepeatedFieldCount(Descriptors.FieldDescriptor field)

Gets the number of elements of a repeated field.

public UnknownFieldSet
getUnknownFields()

Get the UnknownFieldSet for this message.

public boolean
hasField(Descriptors.FieldDescriptor field)

Returns true if the given field is set.

public boolean
hasOneof(Descriptors.OneofDescriptor oneof)

Returns true if the given oneof is set.

Inherited from com.google.protobuf.MessageLiteOrBuilder:
isInitialized

Method Detail

findInitializationErrorsback to summary
public List<String> findInitializationErrors()

Returns a list of field paths (e.g. "foo.bar.baz") of required fields which are not set in this message. You should call MessageLiteOrBuilder#isInitialized() first to check if there are any missing fields, as that method is likely to be much faster than this one even when the message is fully-initialized.

getAllFieldsback to summary
public Map<Descriptors.FieldDescriptor, 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 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.

getDefaultInstanceForTypeback to summary
public Message getDefaultInstanceForType()

Redeclares com.google.protobuf.MessageLiteOrBuilder.getDefaultInstanceForType.

Doc from com.google.protobuf.MessageLiteOrBuilder.getDefaultInstanceForType.

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.

Annotations
@Override
getDescriptorForTypeback to summary
public 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.

getFieldback to summary
public 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 returned. For embedded message fields, the sub-message is returned. For repeated fields, a java.util.List is returned.

getInitializationErrorStringback to summary
public String getInitializationErrorString()

Returns a comma-delimited list of required fields which are not set in this message object. You should call MessageLiteOrBuilder#isInitialized() first to check if there are any missing fields, as that method is likely to be much faster than this one even when the message is fully-initialized.

getOneofFieldDescriptorback to summary
public Descriptors.FieldDescriptor getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)

Obtains the FieldDescriptor if the given oneof is set. Returns null if no field is set.

getRepeatedFieldback to summary
public 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 returned. For embedded message fields, the sub-message is returned.

Exceptions
IllegalArgumentException:
The field is not a repeated field, or field.getContainingType() != getDescriptorForType().
getRepeatedFieldCountback to summary
public 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.

Exceptions
IllegalArgumentException:
The field is not a repeated field, or field.getContainingType() != getDescriptorForType().
getUnknownFieldsback to summary
public UnknownFieldSet getUnknownFields()

Get the UnknownFieldSet for this message.

hasFieldback to summary
public 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.

Exceptions
IllegalArgumentException:
The field is a repeated field, or field.getContainingType() != getDescriptorForType().
hasOneofback to summary
public boolean hasOneof(Descriptors.OneofDescriptor oneof)

Returns true if the given oneof is set.

Exceptions
IllegalArgumentException:
if oneof.getContainingType() != getDescriptorForType().