com.google.protobuf
Class UnknownFieldSet

java.lang.Object
  com.google.protobuf.UnknownFieldSet

public final class UnknownFieldSet
extends java.lang.Object

UnknownFieldSet is used to keep 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 feilds are read by old software that was compiled before the new types were added.

Every Message contains an UnknownFieldSet (and every Message.Builder contains an UnknownFieldSet.Builder).

Most users will never need to use this class.

Author:

[email protected] Kenton Varda

Nested Class Summary

static class	UnknownFieldSet.Builder Builder for UnknownFieldSets.
static class	UnknownFieldSet.Field Represents a single field in an UnknownFieldSet.

Method Summary

java.util.Map<java.lang.Integer,UnknownFieldSet.Field>	asMap() Get a map of fields in the set by number.
static UnknownFieldSet	getDefaultInstance() Get an empty UnknownFieldSet.
UnknownFieldSet.Field	getField(int number) Get a field by number.
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.
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.
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(java.io.InputStream input) Parse an UnknownFieldSet from input and return it.
byte[]	toByteArray() Serializes the message to a byte array and returns it.
ByteString	toByteString() Serializes the message to a ByteString and returns it.
java.lang.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	writeTo(CodedOutputStream output) Serializes the set and writes it to output.
void	writeTo(java.io.OutputStream output) Serializes the message and writes it to output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public static UnknownFieldSet.Builder newBuilder()

Create a new UnknownFieldSet.Builder.

newBuilder

public static UnknownFieldSet.Builder newBuilder(UnknownFieldSet copyFrom)

Create a new UnknownFieldSet.Builder and initialize it to be a copy of copyFrom.

getDefaultInstance

public static UnknownFieldSet getDefaultInstance()

Get an empty UnknownFieldSet.

asMap

public java.util.Map<java.lang.Integer,UnknownFieldSet.Field> asMap()

Get a map of fields in the set by number.

hasField

public boolean hasField(int number)

Check if the given field number is present in the set.

getField

public UnknownFieldSet.Field getField(int number)

Get a field by number. Returns an empty field if not present. Never returns null.

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Serializes the set and writes it to output.

Throws:

java.io.IOException

toString

public final java.lang.String toString()

Converts the set to a string in protocol buffer text format. This is just a trivial wrapper around TextFormat.printToString(UnknownFieldSet).

Overrides:

toString in class java.lang.Object

toByteString

public final ByteString toByteString()

Serializes the message to a ByteString and returns it. This is just a trivial wrapper around writeTo(CodedOutputStream).

toByteArray

public final byte[] toByteArray()

Serializes the message to a byte array and returns it. This is just a trivial wrapper around writeTo(CodedOutputStream).

writeTo

public final void writeTo(java.io.OutputStream output)
                   throws java.io.IOException

Serializes the message and writes it to output. This is just a trivial wrapper around writeTo(CodedOutputStream).

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Get the number of bytes required to encode this set.

writeAsMessageSetTo

public void writeAsMessageSetTo(CodedOutputStream output)
                         throws java.io.IOException

Serializes the set and writes it to output using MessageSet wire format.

Throws:

java.io.IOException

getSerializedSizeAsMessageSet

public int getSerializedSizeAsMessageSet()

Get the number of bytes required to encode this set using MessageSet wire format.

parseFrom

public static UnknownFieldSet parseFrom(CodedInputStream input)
                                 throws java.io.IOException

Parse an UnknownFieldSet from the given input stream.

Throws:

java.io.IOException

parseFrom

public static UnknownFieldSet parseFrom(ByteString data)
                                 throws InvalidProtocolBufferException

Parse data as an UnknownFieldSet and return it.

Throws:

InvalidProtocolBufferException

parseFrom

public static UnknownFieldSet parseFrom(byte[] data)
                                 throws InvalidProtocolBufferException

Parse data as an UnknownFieldSet and return it.

Throws:

InvalidProtocolBufferException

parseFrom

public static UnknownFieldSet parseFrom(java.io.InputStream input)
                                 throws java.io.IOException

Parse an UnknownFieldSet from input and return it.

Throws:

java.io.IOException