com.google.protobuf.Message Interface Reference

Inheritance diagram for com.google.protobuf.Message:

Classes
interface	Builder

Public Member Functions
boolean	equals (Object other)
Parser<? extends Message >	getParserForType ()
int	hashCode ()
Builder	newBuilderForType ()
Builder	toBuilder ()
String	toString ()
Public Member Functions inherited from com.google.protobuf.MessageLite
int	getSerializedSize ()
byte[]	toByteArray ()
ByteString	toByteString ()
void	writeDelimitedTo (OutputStream output) throws IOException
void	writeTo (CodedOutputStream output) throws IOException
void	writeTo (OutputStream output) throws IOException
Public Member Functions inherited from com.google.protobuf.MessageLiteOrBuilder
boolean	isInitialized ()
Public Member Functions inherited from com.google.protobuf.MessageOrBuilder
List< String >	findInitializationErrors ()
Map< Descriptors.FieldDescriptor, Object >	getAllFields ()
Message	getDefaultInstanceForType ()
Descriptors.Descriptor	getDescriptorForType ()
Object	getField (Descriptors.FieldDescriptor field)
String	getInitializationErrorString ()
Descriptors.FieldDescriptor	getOneofFieldDescriptor (Descriptors.OneofDescriptor oneof)
Object	getRepeatedField (Descriptors.FieldDescriptor field, int index)
int	getRepeatedFieldCount (Descriptors.FieldDescriptor field)
UnknownFieldSet	getUnknownFields ()
boolean	hasField (Descriptors.FieldDescriptor field)
boolean	hasOneof (Descriptors.OneofDescriptor oneof)

Detailed Description

Abstract interface implemented by Protocol Message objects.

See also MessageLite, which defines most of the methods that typical users care about. Message adds to it methods that are not available in the "lite" runtime. The biggest added features are introspection and reflection – i.e., getting descriptors for the message type and accessing the field values dynamically.

Author

kento.nosp@m.n@go.nosp@m.ogle..nosp@m.com Kenton Varda

Definition at line 50 of file Message.java.

Member Function Documentation

equals()

boolean com.google.protobuf.Message.equals

(

Object

other

)

Compares the specified object with this message for equality. Returns

true 

if the given object is a message of the same type (as defined by

getDescriptorForType() 

) and has identical values for all of its fields. Subclasses must implement this; inheriting

Object.equals() 

is incorrect.

Parameters

other

object to be compared for equality with this message

Returns

true 

if the specified object is equal to this message

Implemented in com.google.protobuf.AbstractMessage.

getParserForType()

Parser<? extends Message> com.google.protobuf.Message.getParserForType

(

)

Gets the parser for a message of the same type as this message.

Implements com.google.protobuf.MessageLite.

Implemented in com.google.protobuf.DynamicMessage, com.google.protobuf.AbstractMessageTest.AbstractMessageWrapper, com.google.protobuf.test.AbstractMessageTest.AbstractMessageWrapper, com.google.protobuf.MapEntry< K, V >, com.google.protobuf.jruby.SentinelOuterClass.Sentinel, com.google.protobuf.GeneratedMessageV3, and com.google.protobuf.GeneratedMessage.

hashCode()

int com.google.protobuf.Message.hashCode

(

)

Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting

Object.hashCode() 

is incorrect.

Returns

the hash code value for this message

See also

Map::hashCode()

Implemented in com.google.protobuf.AbstractMessage.

newBuilderForType()

Builder com.google.protobuf.Message.newBuilderForType

(

)

Constructs a new builder for a message of the same type as this message.

Implements com.google.protobuf.MessageLite.

Implemented in com.google.protobuf.jruby.SentinelOuterClass.Sentinel, com.google.protobuf.DynamicMessage, com.google.protobuf.MapEntry< K, V >, com.google.protobuf.AbstractMessageTest.AbstractMessageWrapper, and com.google.protobuf.test.AbstractMessageTest.AbstractMessageWrapper.

toBuilder()

Builder com.google.protobuf.Message.toBuilder

(

)

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Implements com.google.protobuf.MessageLite.

Implemented in com.google.protobuf.jruby.SentinelOuterClass.Sentinel, com.google.protobuf.DynamicMessage, com.google.protobuf.MapEntry< K, V >, com.google.protobuf.AbstractMessageTest.AbstractMessageWrapper, and com.google.protobuf.test.AbstractMessageTest.AbstractMessageWrapper.

toString()

String com.google.protobuf.Message.toString

(

)

Converts the message to a string in protocol buffer text format. This is just a trivial wrapper around TextFormat.Printer#printToString(MessageOrBuilder).

Implemented in com.google.protobuf.AbstractMessage.

---

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

• Message.java