com.google.protobuf.MessageOrBuilder Interface Reference

Inheritance diagram for com.google.protobuf.MessageOrBuilder:

Public Member Functions
Message	getDefaultInstanceForType ()
List< String >	findInitializationErrors ()
String	getInitializationErrorString ()
Descriptors.Descriptor	getDescriptorForType ()
Map< Descriptors.FieldDescriptor, Object >	getAllFields ()
boolean	hasOneof (Descriptors.OneofDescriptor oneof)
Descriptors.FieldDescriptor	getOneofFieldDescriptor (Descriptors.OneofDescriptor oneof)
boolean	hasField (Descriptors.FieldDescriptor field)
Object	getField (Descriptors.FieldDescriptor field)
int	getRepeatedFieldCount (Descriptors.FieldDescriptor field)
Object	getRepeatedField (Descriptors.FieldDescriptor field, int index)
UnknownFieldSet	getUnknownFields ()
Public Member Functions inherited from com.google.protobuf.MessageLiteOrBuilder
boolean	isInitialized ()

Detailed Description

Base interface for methods common to Message and Message.Builder to provide type equivalency.

Author

jonp@.nosp@m.goog.nosp@m.le.co.nosp@m.m (Jon Perlow)

Member Function Documentation

findInitializationErrors()

List<String> com.google.protobuf.MessageOrBuilder.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.

Implemented in com.google.protobuf.AbstractMessage.

getAllFields()

Map<Descriptors.FieldDescriptor, Object> com.google.protobuf.MessageOrBuilder.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.

Implemented in com.google.protobuf.GeneratedMessage, com.google.protobuf.DynamicMessage, and com.google.protobuf.MapEntry< K, V >.

getDefaultInstanceForType()

Message com.google.protobuf.MessageOrBuilder.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.

Implements com.google.protobuf.MessageLiteOrBuilder.

Implemented in com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder< MessageType extends ExtendableMessage >, com.google.protobuf.DynamicMessage, and com.google.protobuf.MapEntry< K, V >.

getDescriptorForType()

Descriptors.Descriptor com.google.protobuf.MessageOrBuilder.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.

Implemented in com.google.protobuf.DynamicMessage, com.google.protobuf.Message.Builder, com.google.protobuf.MapEntry< K, V >, and com.google.protobuf.GeneratedMessage.

getField()

Object com.google.protobuf.MessageOrBuilder.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.

getInitializationErrorString()

String com.google.protobuf.MessageOrBuilder.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.

Implemented in com.google.protobuf.AbstractMessage.

getOneofFieldDescriptor()

Descriptors.FieldDescriptor com.google.protobuf.MessageOrBuilder.getOneofFieldDescriptor

(

Descriptors.OneofDescriptor

oneof

)

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

getRepeatedField()

Object com.google.protobuf.MessageOrBuilder.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() .

getRepeatedFieldCount()

int com.google.protobuf.MessageOrBuilder.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() .

getUnknownFields()

UnknownFieldSet com.google.protobuf.MessageOrBuilder.getUnknownFields

(

)

Get the UnknownFieldSet for this message.

Implemented in com.google.protobuf.GeneratedMessage, com.google.protobuf.DynamicMessage, and com.google.protobuf.MapEntry< K, V >.

hasField()

boolean com.google.protobuf.MessageOrBuilder.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() .

hasOneof()

boolean com.google.protobuf.MessageOrBuilder.hasOneof

(

Descriptors.OneofDescriptor

oneof

)

Returns true if the given oneof is set.

Exceptions

IllegalArgumentException

if oneof.getContainingType() != getDescriptorForType() .

---

The documentation for this interface was generated from the following file:

• Source/ThirdParty/libwebrtc/Source/third_party/protobuf/java/core/src/main/java/com/google/protobuf/MessageOrBuilder.java