org.infinispan.protostream

Interface UnknownFieldSet

public interface UnknownFieldSet

UnknownFieldSet is used to keep track of fields which were seen when parsing a protocol message but whose field numbers are not recognized. This usually occurs when new fields are added to a message type and then messages containing those fields are read by old versions of software that was built before the new types were added.

Method Summary

Modifier and Type	Method and Description
<A> A	consumeTag(int tag) Reads and removes a tag value from the set.
boolean	isEmpty() Checks if there are any tags in this set.
boolean	mergeFieldFrom(int tag, com.google.protobuf.CodedInputStream input) Parse a single field from input and merge it into this set.
void	mergeFrom(com.google.protobuf.CodedInputStream input) Parse an entire message from input and merge its fields into this set.
void	mergeVarintField(int tag, int value) Convenience method for merging a new field containing a single varint value.
void	writeTo(com.google.protobuf.CodedOutputStream output) Serializes the set and writes it to output.

Method Detail

isEmpty

boolean isEmpty()

Checks if there are any tags in this set.

mergeFrom

void mergeFrom(com.google.protobuf.CodedInputStream input)
        throws IOException

Parse an entire message from input and merge its fields into this set.

Throws:

IOException

mergeFieldFrom

boolean mergeFieldFrom(int tag,
                       com.google.protobuf.CodedInputStream input)
                throws IOException

Parse a single field from input and merge it into this set.

Parameters:

tag - The field's tag number, which was already parsed.

Returns:

false if the tag is an end group tag.

Throws:

IOException

mergeVarintField

void mergeVarintField(int tag,
                      int value)

Convenience method for merging a new field containing a single varint value. This is used in particular when an unknown enum value is encountered.

writeTo

void writeTo(com.google.protobuf.CodedOutputStream output)
      throws IOException

Serializes the set and writes it to output.

Throws:

IOException

consumeTag

<A> A consumeTag(int tag)

Reads and removes a tag value from the set.

Type Parameters:

A - The expected type of the tag value

Parameters:

tag - the field tag (containing field number and wire type)

Returns:

the first seen value or null if the tag was not found