com.google.protobuf
Class AbstractMessage
- java.lang.Object
- com.google.protobuf.AbstractMessageLite
- com.google.protobuf.AbstractMessage
- All Implemented Interfaces:
- Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder
- Direct Known Subclasses:
- DynamicMessage, com.google.protobuf.GeneratedMessageV3
public abstract class AbstractMessage extends AbstractMessageLite implements Message
A partial implementation of theMessage
interface which implements as many methods of that interface as possible in terms of other methods.
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
AbstractMessage.Builder<BuilderType extends AbstractMessage.Builder<BuilderType>>
A partial implementation of theMessage.Builder
interface which implements as many methods of that interface as possible in terms of other methods.
Constructor Summary
Constructors Constructor and Description AbstractMessage()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description boolean
equals(java.lang.Object other)
Compares the specified object with this message for equality.java.util.List<java.lang.String>
findInitializationErrors()
Returns a list of field paths (e.g.java.lang.String
getInitializationErrorString()
Returns a comma-delimited list of required fields which are not set in this message object.Descriptors.FieldDescriptor
getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)
int
getSerializedSize()
Get the number of bytes required to encode this message.int
hashCode()
Returns the hash code value for this message.boolean
hasOneof(Descriptors.OneofDescriptor oneof)
boolean
isInitialized()
Returns true if all required fields in the message and all embedded messages are set, false otherwise.java.lang.String
toString()
Converts the message to a string in protocol buffer text format.void
writeTo(CodedOutputStream output)
Serializes the message and writes it tooutput
.Methods inherited from class com.google.protobuf.AbstractMessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.Message
getParserForType, newBuilderForType, toBuilder
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField
Method Detail
isInitialized
public boolean isInitialized()
Description copied from interface:MessageLiteOrBuilder
Returns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitialized
in interfaceMessageLiteOrBuilder
findInitializationErrors
public java.util.List<java.lang.String> findInitializationErrors()
Description copied from interface:MessageOrBuilder
Returns a list of field paths (e.g. "foo.bar.baz") of required fields which are not set in this message. You should callMessageLiteOrBuilder.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.- Specified by:
findInitializationErrors
in interfaceMessageOrBuilder
getInitializationErrorString
public java.lang.String getInitializationErrorString()
Description copied from interface:MessageOrBuilder
Returns a comma-delimited list of required fields which are not set in this message object. You should callMessageLiteOrBuilder.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.- Specified by:
getInitializationErrorString
in interfaceMessageOrBuilder
hasOneof
public boolean hasOneof(Descriptors.OneofDescriptor oneof)
- Specified by:
hasOneof
in interfaceMessageOrBuilder
getOneofFieldDescriptor
public Descriptors.FieldDescriptor getOneofFieldDescriptor(Descriptors.OneofDescriptor oneof)
- Specified by:
getOneofFieldDescriptor
in interfaceMessageOrBuilder
toString
public final java.lang.String toString()
Description copied from interface:Message
Converts the message to a string in protocol buffer text format. This is just a trivial wrapper aroundTextFormat.Printer.printToString(MessageOrBuilder)
.
writeTo
public void writeTo(CodedOutputStream output) throws java.io.IOException
Description copied from interface:MessageLite
Serializes the message and writes it tooutput
. This does not flush or close the stream.- Specified by:
writeTo
in interfaceMessageLite
- Throws:
java.io.IOException
getSerializedSize
public int getSerializedSize()
Description copied from interface:MessageLite
Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.- Specified by:
getSerializedSize
in interfaceMessageLite
equals
public boolean equals(java.lang.Object other)
Description copied from interface:Message
Compares the specified object with this message for equality. Returnstrue
if the given object is a message of the same type (as defined bygetDescriptorForType()
) and has identical values for all of its fields. Subclasses must implement this; inheritingObject.equals()
is incorrect.
hashCode
public int hashCode()
Description copied from interface:Message
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; inheritingObject.hashCode()
is incorrect.