Class Field

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.protobuf.Field

All Implemented Interfaces:

FieldOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class Field
extends GeneratedMessageV3
implements FieldOrBuilder

A single field of a message type.

Protobuf type google.protobuf.Field

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Field.Builder	A single field of a message type.
static enum	Field.Cardinality	Whether a field is optional, required, or repeated.
static enum	Field.Kind	Basic field types.

Nested classes/interfaces inherited from class GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.ExtensionDescriptorRetriever, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
private int	cardinality_
static final int	CARDINALITY_FIELD_NUMBER
private static final Field	DEFAULT_INSTANCE
static final int	DEFAULT_VALUE_FIELD_NUMBER
private Object	defaultValue_
static final int	JSON_NAME_FIELD_NUMBER
private Object	jsonName_
private int	kind_
static final int	KIND_FIELD_NUMBER
private byte	memoizedIsInitialized
private Object	name_
static final int	NAME_FIELD_NUMBER
private int	number_
static final int	NUMBER_FIELD_NUMBER
static final int	ONEOF_INDEX_FIELD_NUMBER
private int	oneofIndex_
private List<Option>	options_
static final int	OPTIONS_FIELD_NUMBER
private boolean	packed_
static final int	PACKED_FIELD_NUMBER
private static final Parser<Field>	PARSER
private static final long	serialVersionUID
static final int	TYPE_URL_FIELD_NUMBER
private Object	typeUrl_

Fields inherited from class GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Field()
private	Field(GeneratedMessageV3.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Compares the specified object with this message for equality.
Field.Cardinality	getCardinality()	The field cardinality.
int	getCardinalityValue()	The field cardinality.
static Field	getDefaultInstance()
Field	getDefaultInstanceForType()	Get an instance of the type with no fields set.
String	getDefaultValue()	The string value of the default value of this field.
ByteString	getDefaultValueBytes()	The string value of the default value of this field.
static final Descriptors.Descriptor	getDescriptor()
String	getJsonName()	The field JSON name.
ByteString	getJsonNameBytes()	The field JSON name.
Field.Kind	getKind()	The field type.
int	getKindValue()	The field type.
String	getName()	The field name.
ByteString	getNameBytes()	The field name.
int	getNumber()	The field number.
int	getOneofIndex()	The index of the field type in `Type.oneofs`, for message or enumeration types.
Option	getOptions(int index)	The protocol buffer options.
int	getOptionsCount()	The protocol buffer options.
List<Option>	getOptionsList()	The protocol buffer options.
OptionOrBuilder	getOptionsOrBuilder(int index)	The protocol buffer options.
List<? extends OptionOrBuilder>	getOptionsOrBuilderList()	The protocol buffer options.
boolean	getPacked()	Whether to use alternative packed wire representation.
Parser<Field>	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 message.
String	getTypeUrl()	The field type URL, without the scheme, for message or enumeration types.
ByteString	getTypeUrlBytes()	The field type URL, without the scheme, for message or enumeration types.
final UnknownFieldSet	getUnknownFields()	Get the UnknownFieldSet for this message.
int	hashCode()	Returns the hash code value for this message.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
final boolean	isInitialized()	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
static Field.Builder	newBuilder()
static Field.Builder	newBuilder(Field prototype)
Field.Builder	newBuilderForType()	Constructs a new builder for a message of the same type as this message.
protected Field.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)	TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)	Creates a new instance of this message type.
static Field	parseDelimitedFrom(InputStream input)
static Field	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(byte[] data)
static Field	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(ByteString data)
static Field	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(CodedInputStream input)
static Field	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(InputStream input)
static Field	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(ByteBuffer data)
static Field	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<Field>	parser()
Field.Builder	toBuilder()	Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output)	Serializes the message and writes it to output.

Methods inherited from class GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, enableAlwaysUseFieldBuildersForTesting, getAllFields, getAllFieldsRaw, getDescriptorForType, getField, getFieldRaw, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, setAlwaysUseFieldBuildersForTesting, writeReplace, writeString, writeStringNoTag

Methods inherited from class AbstractMessage

compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, newUninitializedMessageException, setMemoizedSerializedSize, toString

Methods inherited from class AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, getSerializedSize, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

See Also:

• Constant Field Values

kind_

private int kind_

CARDINALITY_FIELD_NUMBER

public static final int CARDINALITY_FIELD_NUMBER

See Also:

• Constant Field Values

cardinality_

private int cardinality_

NUMBER_FIELD_NUMBER

public static final int NUMBER_FIELD_NUMBER

See Also:

• Constant Field Values

number_

private int number_

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

• Constant Field Values

name_

private volatile Object name_

TYPE_URL_FIELD_NUMBER

public static final int TYPE_URL_FIELD_NUMBER

See Also:

• Constant Field Values

typeUrl_

private volatile Object typeUrl_

ONEOF_INDEX_FIELD_NUMBER

public static final int ONEOF_INDEX_FIELD_NUMBER

See Also:

• Constant Field Values

oneofIndex_

private int oneofIndex_

PACKED_FIELD_NUMBER

public static final int PACKED_FIELD_NUMBER

See Also:

• Constant Field Values

packed_

private boolean packed_

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER

See Also:

• Constant Field Values

options_

private List<Option> options_

JSON_NAME_FIELD_NUMBER

public static final int JSON_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

jsonName_

private volatile Object jsonName_

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER

See Also:

• Constant Field Values

defaultValue_

private volatile Object defaultValue_

memoizedIsInitialized

private byte memoizedIsInitialized

DEFAULT_INSTANCE

private static final Field DEFAULT_INSTANCE

PARSER

private static final Parser<Field> PARSER

Constructor Details

Field

private Field(GeneratedMessageV3.Builder<?> builder)

Field

private Field()

Method Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Description copied from class: GeneratedMessageV3

Creates a new instance of this message type. Overridden in the generated code.

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: GeneratedMessageV3

Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getKindValue

public int getKindValue()

The field type.

.google.protobuf.Field.Kind kind = 1;

Specified by:

getKindValue in interface FieldOrBuilder

Returns:

The enum numeric value on the wire for kind.

getKind

public Field.Kind getKind()

The field type.

.google.protobuf.Field.Kind kind = 1;

Specified by:

getKind in interface FieldOrBuilder

Returns:

The kind.

getCardinalityValue

public int getCardinalityValue()

The field cardinality.

.google.protobuf.Field.Cardinality cardinality = 2;

Specified by:

getCardinalityValue in interface FieldOrBuilder

Returns:

The enum numeric value on the wire for cardinality.

getCardinality

public Field.Cardinality getCardinality()

The field cardinality.

.google.protobuf.Field.Cardinality cardinality = 2;

Specified by:

getCardinality in interface FieldOrBuilder

Returns:

The cardinality.

getNumber

public int getNumber()

The field number.

int32 number = 3;

Specified by:

getNumber in interface FieldOrBuilder

Returns:

The number.

getName

public String getName()

The field name.

string name = 4;

Specified by:

getName in interface FieldOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

The field name.

string name = 4;

Specified by:

getNameBytes in interface FieldOrBuilder

Returns:

The bytes for name.

getTypeUrl

public String getTypeUrl()

The field type URL, without the scheme, for message or enumeration
types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

string type_url = 6;

Specified by:

getTypeUrl in interface FieldOrBuilder

Returns:

The typeUrl.

getTypeUrlBytes

public ByteString getTypeUrlBytes()

The field type URL, without the scheme, for message or enumeration
types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

string type_url = 6;

Specified by:

getTypeUrlBytes in interface FieldOrBuilder

Returns:

The bytes for typeUrl.

getOneofIndex

public int getOneofIndex()

The index of the field type in `Type.oneofs`, for message or enumeration
types. The first type has index 1; zero means the type is not in the list.

int32 oneof_index = 7;

Specified by:

getOneofIndex in interface FieldOrBuilder

Returns:

The oneofIndex.

getPacked

public boolean getPacked()

Whether to use alternative packed wire representation.

bool packed = 8;

Specified by:

getPacked in interface FieldOrBuilder

Returns:

The packed.

getOptionsList

public List<Option> getOptionsList()

The protocol buffer options.

repeated .google.protobuf.Option options = 9;

Specified by:

getOptionsList in interface FieldOrBuilder

getOptionsOrBuilderList

public List<? extends OptionOrBuilder> getOptionsOrBuilderList()

The protocol buffer options.

repeated .google.protobuf.Option options = 9;

Specified by:

getOptionsOrBuilderList in interface FieldOrBuilder

getOptionsCount

public int getOptionsCount()

The protocol buffer options.

repeated .google.protobuf.Option options = 9;

Specified by:

getOptionsCount in interface FieldOrBuilder

getOptions

public Option getOptions(int index)

The protocol buffer options.

repeated .google.protobuf.Option options = 9;

Specified by:

getOptions in interface FieldOrBuilder

getOptionsOrBuilder

public OptionOrBuilder getOptionsOrBuilder(int index)

The protocol buffer options.

repeated .google.protobuf.Option options = 9;

Specified by:

getOptionsOrBuilder in interface FieldOrBuilder

getJsonName

public String getJsonName()

The field JSON name.

string json_name = 10;

Specified by:

getJsonName in interface FieldOrBuilder

Returns:

The jsonName.

getJsonNameBytes

public ByteString getJsonNameBytes()

The field JSON name.

string json_name = 10;

Specified by:

getJsonNameBytes in interface FieldOrBuilder

Returns:

The bytes for jsonName.

getDefaultValue

public String getDefaultValue()

The string value of the default value of this field. Proto2 syntax only.

string default_value = 11;

Specified by:

getDefaultValue in interface FieldOrBuilder

Returns:

The defaultValue.

getDefaultValueBytes

public ByteString getDefaultValueBytes()

The string value of the default value of this field. Proto2 syntax only.

string default_value = 11;

Specified by:

getDefaultValueBytes in interface FieldOrBuilder

Returns:

The bytes for defaultValue.

isInitialized

public final boolean isInitialized()

Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Description copied from interface: MessageLite

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that. If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Description copied from interface: Message

Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

Parameters:

obj - object to be compared for equality with this message

Returns:

true if the specified object is equal to this message

hashCode

public int hashCode()

Description copied from interface: Message

Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

Returns:

the hash code value for this message

See Also:

• Map.hashCode()

parseFrom

public static Field parseFrom(ByteBuffer data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Field parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Field parseFrom(ByteString data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Field parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

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

Throws:

InvalidProtocolBufferException

parseFrom

public static Field parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Field parseFrom(InputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Field parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Field parseDelimitedFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static Field parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseFrom

public static Field parseFrom(CodedInputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Field parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

newBuilderForType

public Field.Builder newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Field.Builder newBuilder()

newBuilder

public static Field.Builder newBuilder(Field prototype)

toBuilder

public Field.Builder toBuilder()

Description copied from interface: MessageLite

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Field.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Description copied from class: GeneratedMessageV3

TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Field getDefaultInstance()

parser

public static Parser<Field> parser()

getParserForType

public Parser<Field> getParserForType()

Description copied from interface: MessageLite

Gets the parser for a message of the same type as this message.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Field getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the 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.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder