public final class UnknownFieldSet extends Object implements MessageLite
UnknownFieldSet
keeps track of fields which were seen when parsing a protocol
message but whose field numbers or types are unrecognized. This most frequently occurs when new
fields are added to a message type and then messages containing those fields are read by old
software that was compiled before the new types were added.
Every Message
contains an UnknownFieldSet
(and every Message.Builder
contains a UnknownFieldSet.Builder
).
Most users will never need to use this class.
Modifier and Type | Class and Description |
---|---|
static class |
UnknownFieldSet.Builder
Builder for
UnknownFieldSet s. |
static class |
UnknownFieldSet.Field
Represents a single field in an
UnknownFieldSet . |
static class |
UnknownFieldSet.Parser
Parser to implement MessageLite interface.
|
Modifier and Type | Method and Description |
---|---|
Map<Integer,UnknownFieldSet.Field> |
asMap()
Get a map of fields in the set by number.
|
boolean |
equals(Object other) |
static UnknownFieldSet |
getDefaultInstance()
Get an empty
UnknownFieldSet . |
UnknownFieldSet |
getDefaultInstanceForType()
Get an instance of the type with no fields set.
|
UnknownFieldSet.Field |
getField(int number)
Get a field by number.
|
UnknownFieldSet.Parser |
getParserForType()
Gets the parser for a message of the same type as this message.
|
int |
getSerializedSize()
Get the number of bytes required to encode this set.
|
int |
getSerializedSizeAsMessageSet()
Get the number of bytes required to encode this set using
MessageSet wire format. |
boolean |
hasField(int number)
Check if the given field number is present in the set.
|
int |
hashCode() |
boolean |
isInitialized()
Returns true if all required fields in the message and all embedded messages are set, false
otherwise.
|
static UnknownFieldSet.Builder |
newBuilder()
Create a new
UnknownFieldSet.Builder . |
static UnknownFieldSet.Builder |
newBuilder(UnknownFieldSet copyFrom)
Create a new
UnknownFieldSet.Builder and initialize it to be a copy of copyFrom . |
UnknownFieldSet.Builder |
newBuilderForType()
Constructs a new builder for a message of the same type as this message.
|
static UnknownFieldSet |
parseFrom(byte[] data)
Parse
data as an UnknownFieldSet and return it. |
static UnknownFieldSet |
parseFrom(ByteString data)
Parse
data as an UnknownFieldSet and return it. |
static UnknownFieldSet |
parseFrom(CodedInputStream input)
Parse an
UnknownFieldSet from the given input stream. |
static UnknownFieldSet |
parseFrom(InputStream input)
Parse an
UnknownFieldSet from input and return it. |
UnknownFieldSet.Builder |
toBuilder()
Constructs a builder initialized with the current message.
|
byte[] |
toByteArray()
Serializes the message to a
byte array and returns it. |
ByteString |
toByteString()
Serializes the message to a
ByteString and returns it. |
String |
toString()
Converts the set to a string in protocol buffer text format.
|
void |
writeAsMessageSetTo(CodedOutputStream output)
Serializes the set and writes it to
output using MessageSet wire format. |
void |
writeDelimitedTo(OutputStream output)
Like
MessageLite.writeTo(OutputStream) , but writes the size of the message as a varint before
writing the data. |
void |
writeTo(CodedOutputStream output)
Serializes the set and writes it to
output . |
void |
writeTo(OutputStream output)
Serializes the message and writes it to
output . |
public static UnknownFieldSet.Builder newBuilder()
UnknownFieldSet.Builder
.public static UnknownFieldSet.Builder newBuilder(UnknownFieldSet copyFrom)
UnknownFieldSet.Builder
and initialize it to be a copy of copyFrom
.public static UnknownFieldSet getDefaultInstance()
UnknownFieldSet
.public UnknownFieldSet getDefaultInstanceForType()
MessageLiteOrBuilder
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.getDefaultInstanceForType
in interface MessageLiteOrBuilder
public Map<Integer,UnknownFieldSet.Field> asMap()
public boolean hasField(int number)
public UnknownFieldSet.Field getField(int number)
null
.public void writeTo(CodedOutputStream output) throws IOException
output
.writeTo
in interface MessageLite
IOException
public String toString()
TextFormat.Printer.printToString(UnknownFieldSet)
.public ByteString toByteString()
ByteString
and returns it. This is just a trivial wrapper
around writeTo(CodedOutputStream)
.toByteString
in interface MessageLite
public byte[] toByteArray()
byte
array and returns it. This is just a trivial wrapper
around writeTo(CodedOutputStream)
.toByteArray
in interface MessageLite
public void writeTo(OutputStream output) throws IOException
output
. This is just a trivial wrapper around
writeTo(CodedOutputStream)
.writeTo
in interface MessageLite
IOException
public void writeDelimitedTo(OutputStream output) throws IOException
MessageLite
MessageLite.writeTo(OutputStream)
, but writes the size of the message as a varint before
writing the data. This allows more data to be written to the stream after the message without
the need to delimit the message data yourself. Use MessageLite.Builder.mergeDelimitedFrom(InputStream)
(or the static method YourMessageType.parseDelimitedFrom(InputStream)
) to parse messages written by this method.writeDelimitedTo
in interface MessageLite
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
public void writeAsMessageSetTo(CodedOutputStream output) throws IOException
output
using MessageSet
wire format.IOException
public int getSerializedSizeAsMessageSet()
MessageSet
wire format.public boolean isInitialized()
MessageLiteOrBuilder
isInitialized
in interface MessageLiteOrBuilder
public static UnknownFieldSet parseFrom(CodedInputStream input) throws IOException
UnknownFieldSet
from the given input stream.IOException
public static UnknownFieldSet parseFrom(ByteString data) throws InvalidProtocolBufferException
data
as an UnknownFieldSet
and return it.InvalidProtocolBufferException
public static UnknownFieldSet parseFrom(byte[] data) throws InvalidProtocolBufferException
data
as an UnknownFieldSet
and return it.InvalidProtocolBufferException
public static UnknownFieldSet parseFrom(InputStream input) throws IOException
UnknownFieldSet
from input
and return it.IOException
public UnknownFieldSet.Builder newBuilderForType()
MessageLite
newBuilderForType
in interface MessageLite
public UnknownFieldSet.Builder toBuilder()
MessageLite
toBuilder
in interface MessageLite
public final UnknownFieldSet.Parser getParserForType()
MessageLite
getParserForType
in interface MessageLite
Copyright © 2008–2022. All rights reserved.