Class FieldSet<T extends FieldSet.FieldDescriptorLite<T>>

java.lang.Object

com.google.protobuf.FieldSet<T>

final class FieldSet<T extends FieldSet.FieldDescriptorLite<T>>
extends Object

A class which represents an arbitrary set of fields of some message type. This is used to implement DynamicMessage, and also to represent extensions in GeneratedMessage. This class is package-private, since outside users should probably be using DynamicMessage.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	FieldSet.Builder<T extends FieldSet.FieldDescriptorLite<T>>	A FieldSet Builder that accept a MessageLite.Builder as a field value.
static interface	FieldSet.FieldDescriptorLite<T extends FieldSet.FieldDescriptorLite<T>>	Interface for a FieldDescriptor or lite extension descriptor.

Field Summary

Fields

Modifier and Type	Field	Description
private static final FieldSet<?>	DEFAULT_INSTANCE
private final SmallSortedMap<T,Object>	fields
private boolean	hasLazyField
private boolean	isImmutable

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FieldSet()	Construct a new FieldSet.
private	FieldSet(boolean dummy)	Construct an empty FieldSet.
private	FieldSet(SmallSortedMap<T,Object> fields)

Method Summary

Modifier and Type	Method	Description
void	addRepeatedField(T descriptor, Object value)	Useful for implementing Message.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object).
void	clear()	See Message.Builder.clear().
void	clearField(T descriptor)	Useful for implementing Message.Builder.clearField(Descriptors.FieldDescriptor).
FieldSet<T>	clone()	Clones the FieldSet.
private static <T extends FieldSet.FieldDescriptorLite<T>> SmallSortedMap<T,Object>	cloneAllFieldsMap(SmallSortedMap<T,Object> fields, boolean copyList, boolean resolveLazyFields)
private static <T extends FieldSet.FieldDescriptorLite<T>> void	cloneFieldEntry(Map<T,Object> map, Map.Entry<T,Object> entry, boolean copyList, boolean resolveLazyFields)
private static Object	cloneIfMutable(Object value)
(package private) static int	computeElementSize(WireFormat.FieldType type, int number, Object value)	Compute the number of bytes that would be needed to encode a single tag/value pair of arbitrary type.
(package private) static int	computeElementSizeNoTag(WireFormat.FieldType type, Object value)	Compute the number of bytes that would be needed to encode a particular value of arbitrary type, excluding tag.
static int	computeFieldSize(FieldSet.FieldDescriptorLite<?> descriptor, Object value)	Compute the number of bytes needed to encode a particular field.
(package private) Iterator<Map.Entry<T,Object>>	descendingIterator()	Get an iterator over the fields in the map in descending (i.e.
static <T extends FieldSet.FieldDescriptorLite<T>> FieldSet<T>	emptySet()	Get an immutable empty FieldSet.
boolean	equals(Object o)
Map<T,Object>	getAllFields()	Get a simple map containing all the fields.
Object	getField(T descriptor)	Useful for implementing MessageOrBuilder.getField(Descriptors.FieldDescriptor).
int	getMessageSetSerializedSize()	Like getSerializedSize() but uses MessageSet wire format.
private int	getMessageSetSerializedSize(Map.Entry<T,Object> entry)
Object	getRepeatedField(T descriptor, int index)	Useful for implementing MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int).
int	getRepeatedFieldCount(T descriptor)	Useful for implementing MessageOrBuilder.getRepeatedFieldCount(Descriptors.FieldDescriptor).
int	getSerializedSize()	See MessageLite.getSerializedSize().
(package private) static int	getWireFormatForFieldType(WireFormat.FieldType type, boolean isPacked)	Given a field type, return the wire type.
boolean	hasField(T descriptor)	Useful for implementing MessageOrBuilder.hasField(Descriptors.FieldDescriptor).
int	hashCode()
(package private) boolean	isEmpty()	Returns true if empty, false otherwise.
boolean	isImmutable()	Returns whether the FieldSet is immutable.
boolean	isInitialized()	See MessageLiteOrBuilder.isInitialized().
private static <T extends FieldSet.FieldDescriptorLite<T>> boolean	isInitialized(Map.Entry<T,Object> entry)
private static boolean	isMessageFieldValueInitialized(Object value)
private static boolean	isValidType(WireFormat.FieldType type, Object value)
Iterator<Map.Entry<T,Object>>	iterator()	Get an iterator to the field map.
(package private) boolean	lazyFieldCorrupted(T descriptor)	Returns true if the field is a lazy field and it is corrupted.
void	makeImmutable()	Make this FieldSet immutable from this point forward.
void	mergeFrom(FieldSet<T> other)	Like Message.Builder.mergeFrom(Message), but merges from another FieldSet.
private void	mergeFromField(Map.Entry<T,Object> entry)
static <T extends FieldSet.FieldDescriptorLite<T>> FieldSet.Builder<T>	newBuilder()	Construct a new Builder.
static <T extends FieldSet.FieldDescriptorLite<T>> FieldSet<T>	newFieldSet()	Construct a new FieldSet.
static Object	readPrimitiveField(CodedInputStream input, WireFormat.FieldType type, boolean checkUtf8)	Read a field of any primitive type for immutable messages from a CodedInputStream.
void	setField(T descriptor, Object value)	Useful for implementing Message.Builder.setField(Descriptors.FieldDescriptor,Object).
void	setRepeatedField(T descriptor, int index, Object value)	Useful for implementing Message.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object).
private void	verifyType(T descriptor, Object value)	Verifies that the given object is of the correct type to be a valid value for the given field.
(package private) static void	writeElement(CodedOutputStream output, WireFormat.FieldType type, int number, Object value)	Write a single tag-value pair to the stream.
(package private) static void	writeElementNoTag(CodedOutputStream output, WireFormat.FieldType type, Object value)	Write a field of arbitrary type, without its tag, to the stream.
static void	writeField(FieldSet.FieldDescriptorLite<?> descriptor, Object value, CodedOutputStream output)	Write a single field.
void	writeMessageSetTo(CodedOutputStream output)	Like writeTo(CodedOutputStream) but uses MessageSet wire format.
private void	writeMessageSetTo(Map.Entry<T,Object> entry, CodedOutputStream output)
void	writeTo(CodedOutputStream output)	See MessageLite.writeTo(CodedOutputStream).

Methods inherited from class Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

fields

private final SmallSortedMap<T extends FieldSet.FieldDescriptorLite<T>, Object> fields

isImmutable

private boolean isImmutable

hasLazyField

private boolean hasLazyField

DEFAULT_INSTANCE

private static final FieldSet<?> DEFAULT_INSTANCE

Constructor Details

FieldSet

private FieldSet()

Construct a new FieldSet.

FieldSet

private FieldSet(boolean dummy)

Construct an empty FieldSet. This is only used to initialize DEFAULT_INSTANCE.

FieldSet

private FieldSet(SmallSortedMap<T,Object> fields)

Method Details

newFieldSet

public static <T extends FieldSet.FieldDescriptorLite<T>>
FieldSet<T> newFieldSet()

Construct a new FieldSet.

emptySet

public static <T extends FieldSet.FieldDescriptorLite<T>>
FieldSet<T> emptySet()

Get an immutable empty FieldSet.

newBuilder

public static <T extends FieldSet.FieldDescriptorLite<T>>
FieldSet.Builder<T> newBuilder()

Construct a new Builder.

isEmpty

boolean isEmpty()

Returns true if empty, false otherwise.

makeImmutable

public void makeImmutable()

Make this FieldSet immutable from this point forward.

isImmutable

public boolean isImmutable()

Returns whether the FieldSet is immutable. This is true if it is the emptySet() or if makeImmutable() were called.

Returns:

whether the FieldSet is immutable.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public FieldSet<T> clone()

Clones the FieldSet. The returned FieldSet will be mutable even if the original FieldSet was immutable.

Overrides:

clone in class Object

Returns:

the newly cloned FieldSet

clear

public void clear()

See Message.Builder.clear().

getAllFields

public Map<T,Object> getAllFields()

Get a simple map containing all the fields.

cloneAllFieldsMap

private static <T extends FieldSet.FieldDescriptorLite<T>>
SmallSortedMap<T,Object> cloneAllFieldsMap(SmallSortedMap<T,Object> fields,
 boolean copyList,
 boolean resolveLazyFields)

cloneFieldEntry

private static <T extends FieldSet.FieldDescriptorLite<T>>
void cloneFieldEntry(Map<T,Object> map,
 Map.Entry<T,Object> entry,
 boolean copyList,
 boolean resolveLazyFields)

iterator

public Iterator<Map.Entry<T,Object>> iterator()

Get an iterator to the field map. This iterator should not be leaked out of the protobuf library as it is not protected from mutation when fields is not immutable.

descendingIterator

Iterator<Map.Entry<T,Object>> descendingIterator()

Get an iterator over the fields in the map in descending (i.e. reverse) order. This iterator should not be leaked out of the protobuf library as it is not protected from mutation when fields is not immutable.

hasField

public boolean hasField(T descriptor)

Useful for implementing MessageOrBuilder.hasField(Descriptors.FieldDescriptor).

getField

public Object getField(T descriptor)

Useful for implementing MessageOrBuilder.getField(Descriptors.FieldDescriptor). This method returns null if the field is not set; in this case it is up to the caller to fetch the field's default value.

lazyFieldCorrupted

boolean lazyFieldCorrupted(T descriptor)

Returns true if the field is a lazy field and it is corrupted.

setField

public void setField(T descriptor,
 Object value)

Useful for implementing Message.Builder.setField(Descriptors.FieldDescriptor,Object).

clearField

public void clearField(T descriptor)

Useful for implementing Message.Builder.clearField(Descriptors.FieldDescriptor).

getRepeatedFieldCount

public int getRepeatedFieldCount(T descriptor)

Useful for implementing MessageOrBuilder.getRepeatedFieldCount(Descriptors.FieldDescriptor).

getRepeatedField

public Object getRepeatedField(T descriptor,
 int index)

Useful for implementing MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int).

setRepeatedField

public void setRepeatedField(T descriptor,
 int index,
 Object value)

Useful for implementing Message.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object).

addRepeatedField

public void addRepeatedField(T descriptor,
 Object value)

Useful for implementing Message.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object).

verifyType

private void verifyType(T descriptor,
 Object value)

Verifies that the given object is of the correct type to be a valid value for the given field. (For repeated fields, this checks if the object is the right type to be one element of the field.)

Throws:

IllegalArgumentException - the value is not of the right type

isValidType

private static boolean isValidType(WireFormat.FieldType type,
 Object value)

isInitialized

public boolean isInitialized()

See MessageLiteOrBuilder.isInitialized(). Note: Since FieldSet itself does not have any way of knowing about required fields that aren't actually present in the set, it is up to the caller to check that all required fields are present.

isInitialized

private static <T extends FieldSet.FieldDescriptorLite<T>>
boolean isInitialized(Map.Entry<T,Object> entry)

isMessageFieldValueInitialized

private static boolean isMessageFieldValueInitialized(Object value)

getWireFormatForFieldType

static int getWireFormatForFieldType(WireFormat.FieldType type,
 boolean isPacked)

Given a field type, return the wire type.

Returns:

One of the WIRETYPE_ constants defined in WireFormat.

mergeFrom

public void mergeFrom(FieldSet<T> other)

Like Message.Builder.mergeFrom(Message), but merges from another FieldSet.

cloneIfMutable

private static Object cloneIfMutable(Object value)

mergeFromField

private void mergeFromField(Map.Entry<T,Object> entry)

readPrimitiveField

public static Object readPrimitiveField(CodedInputStream input,
 WireFormat.FieldType type,
 boolean checkUtf8)
                                 throws IOException

Read a field of any primitive type for immutable messages from a CodedInputStream. Enums, groups, and embedded messages are not handled by this method.

Parameters:

input - the stream from which to read

type - declared type of the field

checkUtf8 - When true, check that the input is valid UTF-8

Returns:

an object representing the field's value, of the exact type which would be returned by MessageOrBuilder.getField(Descriptors.FieldDescriptor) for this field

Throws:

IOException

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

See MessageLite.writeTo(CodedOutputStream).

Throws:

IOException

writeMessageSetTo

public void writeMessageSetTo(CodedOutputStream output)
                       throws IOException

Like writeTo(CodedOutputStream) but uses MessageSet wire format.

Throws:

IOException

writeMessageSetTo

private void writeMessageSetTo(Map.Entry<T,Object> entry,
 CodedOutputStream output)
                        throws IOException

Throws:

IOException

writeElement

static void writeElement(CodedOutputStream output,
 WireFormat.FieldType type,
 int number,
 Object value)
                  throws IOException

Write a single tag-value pair to the stream.

Parameters:

output - The output stream.

type - The field's type.

number - The field's number.

value - Object representing the field's value. Must be of the exact type which would be returned by MessageOrBuilder.getField(Descriptors.FieldDescriptor) for this field.

Throws:

IOException

writeElementNoTag

static void writeElementNoTag(CodedOutputStream output,
 WireFormat.FieldType type,
 Object value)
                       throws IOException

Write a field of arbitrary type, without its tag, to the stream.

Parameters:

output - The output stream.

type - The field's type.

value - Object representing the field's value. Must be of the exact type which would be returned by MessageOrBuilder.getField(Descriptors.FieldDescriptor) for this field.

Throws:

IOException

writeField

public static void writeField(FieldSet.FieldDescriptorLite<?> descriptor,
 Object value,
 CodedOutputStream output)
                       throws IOException

Write a single field.

Throws:

IOException

getSerializedSize

public int getSerializedSize()

See MessageLite.getSerializedSize(). It's up to the caller to cache the resulting size if desired.

getMessageSetSerializedSize

public int getMessageSetSerializedSize()

Like getSerializedSize() but uses MessageSet wire format.

getMessageSetSerializedSize

private int getMessageSetSerializedSize(Map.Entry<T,Object> entry)

computeElementSize

static int computeElementSize(WireFormat.FieldType type,
 int number,
 Object value)

Compute the number of bytes that would be needed to encode a single tag/value pair of arbitrary type.

Parameters:

type - The field's type.

number - The field's number.

value - Object representing the field's value. Must be of the exact type which would be returned by MessageOrBuilder.getField(Descriptors.FieldDescriptor) for this field.

computeElementSizeNoTag

static int computeElementSizeNoTag(WireFormat.FieldType type,
 Object value)

Compute the number of bytes that would be needed to encode a particular value of arbitrary type, excluding tag.

Parameters:

type - The field's type.

value - Object representing the field's value. Must be of the exact type which would be returned by MessageOrBuilder.getField(Descriptors.FieldDescriptor) for this field.

computeFieldSize

public static int computeFieldSize(FieldSet.FieldDescriptorLite<?> descriptor,
 Object value)

Compute the number of bytes needed to encode a particular field.