Protocol Buffers [Core] 3.7.1 · com.google.protobuf.FieldSet

Modifier and Type	Class and Description
public static interface	FieldSet.FieldDescriptorLite<T extends FieldSet.FieldDescriptorLite<T>> Interface for a FieldDescriptor or lite extension descriptor.

Modifier and Type	Field and Description
private static final FieldSet<FieldDescriptorType extends FieldSet.FieldDescriptorLite<FieldDescriptorType>>	DEFAULT_INSTANCE
private final SmallSortedMap<FieldDescriptorType, Object>	fields
private boolean	hasLazyField
private boolean	isImmutable

Access	Constructor and Description
private	FieldSet() Construct a new FieldSet.
private	FieldSet(final boolean dummy) Construct an empty FieldSet.

Method Summary

Modifier and Type	Method and Description
public void	addRepeatedField(final FieldDescriptorType descriptor, final Object value) Useful for implementing `Message.Builder#addRepeatedField(Descriptors.FieldDescriptor, Object)`.
public void	clear() See `Message.Builder#clear()`.
public void	clearField(final FieldDescriptorType descriptor) Useful for implementing `Message.Builder#clearField(Descriptors.FieldDescriptor)`.
public FieldSet<FieldDescriptorType>	Returns: the newly cloned FieldSet clone() Overrides java.lang.Object.clone. Clones the FieldSet.
private void	cloneFieldEntry(Map<FieldDescriptorType, Object> map, Map.Entry<FieldDescriptorType, Object> entry)
private Object	cloneIfMutable(Object value)
pack-priv static int	computeElementSize(final WireFormat.FieldType The field's type. type, final int The field's number. number, final Object Object representing the field's value. Must be of the exact type which would be returned by `Message#getField(Descriptors.FieldDescriptor)` for this field. value) Compute the number of bytes that would be needed to encode a single tag/value pair of arbitrary type.
pack-priv static int	computeElementSizeNoTag(final WireFormat.FieldType The field's type. type, final Object Object representing the field's value. Must be of the exact type which would be returned by `Message#getField(Descriptors.FieldDescriptor)` for this field. value) Compute the number of bytes that would be needed to encode a particular value of arbitrary type, excluding tag.
public static int	computeFieldSize(final FieldSet.FieldDescriptorLite<?> descriptor, final Object value) Compute the number of bytes needed to encode a particular field.
public static <T extends FieldSet.FieldDescriptorLite<T>> FieldSet<T>	emptySet() Get an immutable empty FieldSet.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Map<FieldDescriptorType, Object>	getAllFields() Get a simple map containing all the fields.
public Object	getField(final FieldDescriptorType descriptor) Useful for implementing `Message#getField(Descriptors.FieldDescriptor)`.
public int	getMessageSetSerializedSize() Like `getSerializedSize` but uses MessageSet wire format.
private int	getMessageSetSerializedSize(final Map.Entry<FieldDescriptorType, Object> entry)
public Object	getRepeatedField(final FieldDescriptorType descriptor, final int index) Useful for implementing `Message#getRepeatedField(Descriptors.FieldDescriptor, int)`.
public int	getRepeatedFieldCount(final FieldDescriptorType descriptor) Useful for implementing `Message#getRepeatedFieldCount(Descriptors.FieldDescriptor)`.
public int	getSerializedSize() See `Message#getSerializedSize()`.
pack-priv static int	Returns: One of the `WIRETYPE_` constants defined in `WireFormat`. getWireFormatForFieldType(final WireFormat.FieldType type, boolean isPacked) Given a field type, return the wire type.
public boolean	hasField(final FieldDescriptorType descriptor) Useful for implementing `Message#hasField(Descriptors.FieldDescriptor)`.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
pack-priv boolean	isEmpty() Returns `true` if empty, `false` otherwise.
public boolean	Returns: whether the FieldSet is immutable. isImmutable() Returns whether the FieldSet is immutable.
public boolean	isInitialized() See `Message#isInitialized()`.
private boolean	isInitialized(final Map.Entry<FieldDescriptorType, Object> entry)
public Iterator<Map.Entry<FieldDescriptorType, Object>>	iterator() Get an iterator to the field map.
public void	makeImmutable() Make this FieldSet immutable from this point forward.
public void	mergeFrom(final FieldSet<FieldDescriptorType> other) Like `Message.Builder#mergeFrom(Message)`, but merges from another `FieldSet`.
private void	mergeFromField(final Map.Entry<FieldDescriptorType, Object> entry)
public static <T extends FieldSet.FieldDescriptorLite<T>> FieldSet<T>	newFieldSet() Construct a new FieldSet.
public static Object	Returns: An object representing the field's value, of the exact type which would be returned by `Message#getField(Descriptors.FieldDescriptor)` for this field. readPrimitiveField(CodedInputStream The stream from which to read. input, final WireFormat.FieldType Declared type of the field. type, boolean When true, check that the input is valid utf8. checkUtf8) Read a field of any primitive type for immutable messages from a CodedInputStream.
public void	setField(final FieldDescriptorType descriptor, Object value) Useful for implementing `Message.Builder#setField(Descriptors.FieldDescriptor, Object)`.
public void	setRepeatedField(final FieldDescriptorType descriptor, final int index, final Object value) Useful for implementing `Message.Builder#setRepeatedField(Descriptors.FieldDescriptor, int, Object)`.
private static void	verifyType(final WireFormat.FieldType type, final Object value) Verifies that the given object is of the correct type to be a valid value for the given field.
pack-priv static void	writeElement(final CodedOutputStream The output stream. output, final WireFormat.FieldType The field's type. type, final int The field's number. number, final Object Object representing the field's value. Must be of the exact type which would be returned by `Message#getField(Descriptors.FieldDescriptor)` for this field. value) Write a single tag-value pair to the stream.
pack-priv static void	writeElementNoTag(final CodedOutputStream The output stream. output, final WireFormat.FieldType The field's type. type, final Object Object representing the field's value. Must be of the exact type which would be returned by `Message#getField(Descriptors.FieldDescriptor)` for this field. value) Write a field of arbitrary type, without its tag, to the stream.
public static void	writeField(final FieldSet.FieldDescriptorLite<?> descriptor, final Object value, final CodedOutputStream output) Write a single field.
public void	writeMessageSetTo(final CodedOutputStream output) Like `writeTo` but uses MessageSet wire format.
private void	writeMessageSetTo(final Map.Entry<FieldDescriptorType, Object> entry, final CodedOutputStream output)
public void	writeTo(final CodedOutputStream output) See `Message#writeTo(CodedOutputStream)`.

Inherited from java.lang.Object:: finalize getClass notify notifyAll toString wait wait wait

DEFAULT_INSTANCE	back to summary
private static final FieldSet<FieldDescriptorType extends FieldSet.FieldDescriptorLite<FieldDescriptorType>> DEFAULT_INSTANCE Annotations @SuppressWarnings:rawtypes

fields	back to summary
private final SmallSortedMap<FieldDescriptorType, Object> fields

hasLazyField	back to summary
private boolean hasLazyField

isImmutable	back to summary
private boolean isImmutable

FieldSet	back to summary
private FieldSet() Construct a new FieldSet.

FieldSet	back to summary
private FieldSet(final boolean dummy) Construct an empty FieldSet. This is only used to initialize DEFAULT_INSTANCE.

Method Detail

addRepeatedField back to summary

addRepeatedField	back to summary
public void addRepeatedField(final FieldDescriptorType descriptor, final Object value) Useful for implementing `Message.Builder#addRepeatedField(Descriptors.FieldDescriptor, Object)`. Annotations @SuppressWarnings:unchecked

public void addRepeatedField(final FieldDescriptorType descriptor, final Object value)

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

Annotations

@SuppressWarnings:unchecked

clear	back to summary
public void clear() See `Message.Builder#clear()`.

clearField	back to summary
public void clearField(final FieldDescriptorType descriptor) Useful for implementing `Message.Builder#clearField(Descriptors.FieldDescriptor)`.

clone	back to summary
public FieldSet<FieldDescriptorType> clone() Overrides java.lang.Object.clone. Clones the FieldSet. The returned FieldSet will be mutable even if the original FieldSet was immutable. Returns:FieldSet<FieldDescriptorType> the newly cloned FieldSet Annotations @Override

clone

back to summary

public FieldSet<FieldDescriptorType> clone()

Overrides java.lang.Object.clone.

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

Returns:FieldSet<FieldDescriptorType>

the newly cloned FieldSet

Annotations

@Override

cloneFieldEntry	back to summary
private void cloneFieldEntry(Map<FieldDescriptorType, Object> map, Map.Entry<FieldDescriptorType, Object> entry)

cloneIfMutable	back to summary
private Object cloneIfMutable(Object value)

computeElementSize back to summary

computeElementSize	back to summary
pack-priv static int computeElementSize(final WireFormat.FieldType type, final int number, final Object value) Compute the number of bytes that would be needed to encode a single tag/value pair of arbitrary type. Parameters type:WireFormat.FieldType The field's type. number:int The field's number. value:Object Object representing the field's value. Must be of the exact type which would be returned by `Message#getField(Descriptors.FieldDescriptor)` for this field.

pack-priv static int computeElementSize(final WireFormat.FieldType type, final int number, final Object value)

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

Parameters

type:WireFormat.FieldType: The field's type.
number:int: The field's number.
value:Object: Object representing the field's value. Must be of the exact type which would be returned by Message#getField(Descriptors.FieldDescriptor) for this field.

computeElementSizeNoTag back to summary

computeElementSizeNoTag	back to summary
pack-priv static int computeElementSizeNoTag(final WireFormat.FieldType type, final Object value) Compute the number of bytes that would be needed to encode a particular value of arbitrary type, excluding tag. Parameters type:WireFormat.FieldType The field's type. value:Object Object representing the field's value. Must be of the exact type which would be returned by `Message#getField(Descriptors.FieldDescriptor)` for this field.

pack-priv static int computeElementSizeNoTag(final WireFormat.FieldType type, final Object value)

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

Parameters

type:WireFormat.FieldType: The field's type.
value:Object: Object representing the field's value. Must be of the exact type which would be returned by Message#getField(Descriptors.FieldDescriptor) for this field.

computeFieldSize	back to summary
public static int computeFieldSize(final FieldSet.FieldDescriptorLite<?> descriptor, final Object value) Compute the number of bytes needed to encode a particular field.

emptySet	back to summary
public static <T extends FieldSet.FieldDescriptorLite<T>> FieldSet<T> emptySet() Get an immutable empty FieldSet. Annotations @SuppressWarnings:unchecked

emptySet

back to summary

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

Get an immutable empty FieldSet.

Annotations

@SuppressWarnings:unchecked

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAllFields	back to summary
public Map<FieldDescriptorType, Object> getAllFields() Get a simple map containing all the fields.

getField	back to summary
public Object getField(final FieldDescriptorType descriptor) Useful for implementing `Message#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.

getMessageSetSerializedSize	back to summary
public int getMessageSetSerializedSize() Like `getSerializedSize` but uses MessageSet wire format.

getMessageSetSerializedSize	back to summary
private int getMessageSetSerializedSize(final Map.Entry<FieldDescriptorType, Object> entry)

getRepeatedField	back to summary
public Object getRepeatedField(final FieldDescriptorType descriptor, final int index) Useful for implementing `Message#getRepeatedField(Descriptors.FieldDescriptor, int)`.

getRepeatedFieldCount	back to summary
public int getRepeatedFieldCount(final FieldDescriptorType descriptor) Useful for implementing `Message#getRepeatedFieldCount(Descriptors.FieldDescriptor)`.

getSerializedSize	back to summary
public int getSerializedSize() See `Message#getSerializedSize()`. It's up to the caller to cache the resulting size if desired.

getWireFormatForFieldType back to summary

getWireFormatForFieldType	back to summary
pack-priv static int getWireFormatForFieldType(final WireFormat.FieldType type, boolean isPacked) Given a field type, return the wire type. Returns:int One of the `WIRETYPE_` constants defined in `WireFormat`.

pack-priv static int getWireFormatForFieldType(final WireFormat.FieldType type, boolean isPacked)

Given a field type, return the wire type.

Returns:int: One of the WIRETYPE_ constants defined in WireFormat.

hasField	back to summary
public boolean hasField(final FieldDescriptorType descriptor) Useful for implementing `Message#hasField(Descriptors.FieldDescriptor)`.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isEmpty	back to summary
pack-priv boolean isEmpty() Returns `true` if empty, `false` otherwise.

isImmutable back to summary

isImmutable	back to summary
public boolean isImmutable() Returns whether the FieldSet is immutable. This is true if it is the `emptySet` or if `makeImmutable` were called. Returns:boolean whether the FieldSet is immutable.

public boolean isImmutable()

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

Returns:boolean: whether the FieldSet is immutable.

isInitialized	back to summary
public boolean isInitialized() See `Message#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	back to summary
private boolean isInitialized(final Map.Entry<FieldDescriptorType, Object> entry) Annotations @SuppressWarnings:unchecked

iterator	back to summary
public Iterator<Map.Entry<FieldDescriptorType, 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.

makeImmutable	back to summary
public void makeImmutable() Make this FieldSet immutable from this point forward. Annotations @SuppressWarnings:unchecked

makeImmutable

back to summary

public void makeImmutable()

Make this FieldSet immutable from this point forward.

Annotations

@SuppressWarnings:unchecked

mergeFrom	back to summary
public void mergeFrom(final FieldSet<FieldDescriptorType> other) Like `Message.Builder#mergeFrom(Message)`, but merges from another `FieldSet`.

mergeFromField	back to summary
private void mergeFromField(final Map.Entry<FieldDescriptorType, Object> entry) Annotations @SuppressWarnings:unchecked, rawtypes

newFieldSet	back to summary
public static <T extends FieldSet.FieldDescriptorLite<T>> FieldSet<T> newFieldSet() Construct a new FieldSet.

readPrimitiveField back to summary

readPrimitiveField	back to summary
public static Object readPrimitiveField(CodedInputStream input, final 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:CodedInputStream The stream from which to read. type:WireFormat.FieldType Declared type of the field. checkUtf8:boolean When true, check that the input is valid utf8. Returns:Object An object representing the field's value, of the exact type which would be returned by `Message#getField(Descriptors.FieldDescriptor)` for this field.

public static Object readPrimitiveField(CodedInputStream input, final 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:CodedInputStream: The stream from which to read.
type:WireFormat.FieldType: Declared type of the field.
checkUtf8:boolean: When true, check that the input is valid utf8.

Returns:Object

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

setField back to summary

setField	back to summary
public void setField(final FieldDescriptorType descriptor, Object value) Useful for implementing `Message.Builder#setField(Descriptors.FieldDescriptor, Object)`. Annotations @SuppressWarnings:unchecked, rawtypes

public void setField(final FieldDescriptorType descriptor, Object value)

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

Annotations

@SuppressWarnings:unchecked, rawtypes

setRepeatedField back to summary

setRepeatedField	back to summary
public void setRepeatedField(final FieldDescriptorType descriptor, final int index, final Object value) Useful for implementing `Message.Builder#setRepeatedField(Descriptors.FieldDescriptor, int, Object)`. Annotations @SuppressWarnings:unchecked

public void setRepeatedField(final FieldDescriptorType descriptor, final int index, final Object value)

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

Annotations

@SuppressWarnings:unchecked

verifyType	back to summary
private static void verifyType(final WireFormat.FieldType type, final 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.) Exceptions IllegalArgumentException: The value is not of the right type.

verifyType

back to summary

private static void verifyType(final WireFormat.FieldType type, final 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.)

Exceptions

IllegalArgumentException:: The value is not of the right type.

writeElement back to summary

writeElement	back to summary
pack-priv static void writeElement(final CodedOutputStream output, final WireFormat.FieldType type, final int number, final Object value) throws IOException Write a single tag-value pair to the stream. Parameters output:CodedOutputStream The output stream. type:WireFormat.FieldType The field's type. number:int The field's number. value:Object Object representing the field's value. Must be of the exact type which would be returned by `Message#getField(Descriptors.FieldDescriptor)` for this field.

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

Write a single tag-value pair to the stream.

Parameters

output:CodedOutputStream: The output stream.
type:WireFormat.FieldType: The field's type.
number:int: The field's number.
value:Object: Object representing the field's value. Must be of the exact type which would be returned by Message#getField(Descriptors.FieldDescriptor) for this field.

writeElementNoTag back to summary

writeElementNoTag	back to summary
pack-priv static void writeElementNoTag(final CodedOutputStream output, final WireFormat.FieldType type, final Object value) throws IOException Write a field of arbitrary type, without its tag, to the stream. Parameters output:CodedOutputStream The output stream. type:WireFormat.FieldType The field's type. value:Object Object representing the field's value. Must be of the exact type which would be returned by `Message#getField(Descriptors.FieldDescriptor)` for this field.

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

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

Parameters

output:CodedOutputStream: The output stream.
type:WireFormat.FieldType: The field's type.
value:Object: Object representing the field's value. Must be of the exact type which would be returned by Message#getField(Descriptors.FieldDescriptor) for this field.

writeField	back to summary
public static void writeField(final FieldSet.FieldDescriptorLite<?> descriptor, final Object value, final CodedOutputStream output) throws IOException Write a single field.

writeMessageSetTo	back to summary
public void writeMessageSetTo(final CodedOutputStream output) throws IOException Like `writeTo` but uses MessageSet wire format.

writeMessageSetTo	back to summary
private void writeMessageSetTo(final Map.Entry<FieldDescriptorType, Object> entry, final CodedOutputStream output) throws IOException

writeTo	back to summary
public void writeTo(final CodedOutputStream output) throws IOException See `Message#writeTo(CodedOutputStream)`.

Modifier and Type	Method and Description
public Internal.EnumLiteMap<?>	getEnumType()
public WireFormat.JavaType	getLiteJavaType()
public WireFormat.FieldType	getLiteType()
public int	getNumber()
public MessageLite.Builder	internalMergeFrom(MessageLite.Builder to, MessageLite from)
public boolean	isPacked()
public boolean	isRepeated()

pack-priv final Class FieldSet<FieldDescriptorType extends FieldSet.FieldDescriptorLite<FieldDescriptorType>>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface FieldSet.FieldDescriptorLite<T extends FieldSet.FieldDescriptorLite<T>>

Method Summary

Method Detail