com.google.protobuf

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, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class Field
extends com.google.protobuf.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 and Description
static class	Field.Builder A single field of a message type.
static class	Field.Cardinality Whether a field is optional, required, or repeated.
static class	Field.Kind Basic field types.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	CARDINALITY_FIELD_NUMBER
static int	DEFAULT_VALUE_FIELD_NUMBER
static int	JSON_NAME_FIELD_NUMBER
static int	KIND_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	NUMBER_FIELD_NUMBER
static int	ONEOF_INDEX_FIELD_NUMBER
static int	OPTIONS_FIELD_NUMBER
static int	PACKED_FIELD_NUMBER
static int	TYPE_URL_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Field.Cardinality	getCardinality() The field cardinality.
int	getCardinalityValue() The field cardinality.
static Field	getDefaultInstance()
Field	getDefaultInstanceForType()
java.lang.String	getDefaultValue() The string value of the default value of this field.
com.google.protobuf.ByteString	getDefaultValueBytes() The string value of the default value of this field.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
java.lang.String	getJsonName() The field JSON name.
com.google.protobuf.ByteString	getJsonNameBytes() The field JSON name.
Field.Kind	getKind() The field type.
int	getKindValue() The field type.
java.lang.String	getName() The field name.
com.google.protobuf.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.
java.util.List<Option>	getOptionsList() The protocol buffer options.
OptionOrBuilder	getOptionsOrBuilder(int index) The protocol buffer options.
java.util.List<? extends OptionOrBuilder>	getOptionsOrBuilderList() The protocol buffer options.
boolean	getPacked() Whether to use alternative packed wire representation.
com.google.protobuf.Parser<Field>	getParserForType()
int	getSerializedSize()
java.lang.String	getTypeUrl() The field type URL, without the scheme, for message or enumeration types.
com.google.protobuf.ByteString	getTypeUrlBytes() The field type URL, without the scheme, for message or enumeration types.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Field.Builder	newBuilder()
static Field.Builder	newBuilder(Field prototype)
Field.Builder	newBuilderForType()
protected Field.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Field	parseDelimitedFrom(java.io.InputStream input)
static Field	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(byte[] data)
static Field	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(java.nio.ByteBuffer data)
static Field	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(com.google.protobuf.ByteString data)
static Field	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(com.google.protobuf.CodedInputStream input)
static Field	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(java.io.InputStream input)
static Field	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Field>	parser()
Field.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

See Also:

Constant Field Values

CARDINALITY_FIELD_NUMBER

public static final int CARDINALITY_FIELD_NUMBER

See Also:

Constant Field Values

NUMBER_FIELD_NUMBER

public static final int NUMBER_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_URL_FIELD_NUMBER

public static final int TYPE_URL_FIELD_NUMBER

See Also:

Constant Field Values

ONEOF_INDEX_FIELD_NUMBER

public static final int ONEOF_INDEX_FIELD_NUMBER

See Also:

Constant Field Values

PACKED_FIELD_NUMBER

public static final int PACKED_FIELD_NUMBER

See Also:

Constant Field Values

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

JSON_NAME_FIELD_NUMBER

public static final int JSON_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getKindValue

public int getKindValue()

 The field type.
 

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

Specified by:

getKindValue in interface FieldOrBuilder

getKind

public Field.Kind getKind()

 The field type.
 

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

Specified by:

getKind in interface FieldOrBuilder

getCardinalityValue

public int getCardinalityValue()

 The field cardinality.
 

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

Specified by:

getCardinalityValue in interface FieldOrBuilder

getCardinality

public Field.Cardinality getCardinality()

 The field cardinality.
 

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

Specified by:

getCardinality in interface FieldOrBuilder

getNumber

public int getNumber()

 The field number.
 

int32 number = 3;

Specified by:

getNumber in interface FieldOrBuilder

getName

public java.lang.String getName()

 The field name.
 

string name = 4;

Specified by:

getName in interface FieldOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The field name.
 

string name = 4;

Specified by:

getNameBytes in interface FieldOrBuilder

getTypeUrl

public java.lang.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

getTypeUrlBytes

public com.google.protobuf.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

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

getPacked

public boolean getPacked()

 Whether to use alternative packed wire representation.
 

bool packed = 8;

Specified by:

getPacked in interface FieldOrBuilder

getOptionsList

public java.util.List<Option> getOptionsList()

 The protocol buffer options.
 

repeated .google.protobuf.Option options = 9;

Specified by:

getOptionsList in interface FieldOrBuilder

getOptionsOrBuilderList

public java.util.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 java.lang.String getJsonName()

 The field JSON name.
 

string json_name = 10;

Specified by:

getJsonName in interface FieldOrBuilder

getJsonNameBytes

public com.google.protobuf.ByteString getJsonNameBytes()

 The field JSON name.
 

string json_name = 10;

Specified by:

getJsonNameBytes in interface FieldOrBuilder

getDefaultValue

public java.lang.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

getDefaultValueBytes

public com.google.protobuf.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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

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

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Field parseFrom(java.nio.ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field parseFrom(java.nio.ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field parseFrom(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field parseFrom(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field parseFrom(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field parseFrom(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseFrom

public static Field parseFrom(java.io.InputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Field parseDelimitedFrom(java.io.InputStream input)
                                throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Field parseDelimitedFrom(java.io.InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Field parseFrom(com.google.protobuf.CodedInputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Field parseFrom(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Field.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Field.Builder newBuilder()

newBuilder

public static Field.Builder newBuilder(Field prototype)

toBuilder

public Field.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Field.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Field getDefaultInstance()

parser

public static com.google.protobuf.Parser<Field> parser()

getParserForType

public com.google.protobuf.Parser<Field> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Field getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder