java.lang.Object
- com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
- - com.google.protobuf.GeneratedMessageLite<Field,Field.Builder>
  - - com.google.protobuf.Field

All Implemented Interfaces:: FieldOrBuilder, MessageLite, MessageLiteOrBuilder

public final class Field
extends GeneratedMessageLite<Field,Field.Builder>
implements FieldOrBuilder

 A single field of a message type.

Protobuf type google.protobuf.Field

Nested Class Summary

Nested Classes
Modifier and Type	Class	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.GeneratedMessageLite
GeneratedMessageLite.DefaultInstanceBasedParser<T extends GeneratedMessageLite<T,?>>, GeneratedMessageLite.ExtendableBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.ExtendableMessage<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.ExtensionDescriptor, GeneratedMessageLite.GeneratedExtension<ContainingType extends MessageLite,Type>, GeneratedMessageLite.MethodToInvoke, GeneratedMessageLite.SerializedForm

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	Description
`private int`	`cardinality_`
`static int`	`CARDINALITY_FIELD_NUMBER`
`private static Field`	`DEFAULT_INSTANCE`
`static int`	`DEFAULT_VALUE_FIELD_NUMBER`
`private java.lang.String`	`defaultValue_`
`static int`	`JSON_NAME_FIELD_NUMBER`
`private java.lang.String`	`jsonName_`
`private int`	`kind_`
`static int`	`KIND_FIELD_NUMBER`
`private java.lang.String`	`name_`
`static int`	`NAME_FIELD_NUMBER`
`private int`	`number_`
`static int`	`NUMBER_FIELD_NUMBER`
`static int`	`ONEOF_INDEX_FIELD_NUMBER`
`private int`	`oneofIndex_`
`private Internal.ProtobufList<Option>`	`options_`
`static int`	`OPTIONS_FIELD_NUMBER`
`private boolean`	`packed_`
`static int`	`PACKED_FIELD_NUMBER`
`private static Parser<Field>`	`PARSER`
`static int`	`TYPE_URL_FIELD_NUMBER`
`private java.lang.String`	`typeUrl_`

Fields inherited from class com.google.protobuf.GeneratedMessageLite
UNINITIALIZED_HASH_CODE, UNINITIALIZED_SERIALIZED_SIZE, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Constructor Summary

Constructors
Modifier Constructor Description

private Field()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private void`	`addAllOptions(java.lang.Iterable<? extends Option> values)`	The protocol buffer options.
`private void`	`addOptions(int index, Option value)`	The protocol buffer options.
`private void`	`addOptions(Option value)`	The protocol buffer options.
`private void`	`clearCardinality()`	The field cardinality.
`private void`	`clearDefaultValue()`	The string value of the default value of this field.
`private void`	`clearJsonName()`	The field JSON name.
`private void`	`clearKind()`	The field type.
`private void`	`clearName()`	The field name.
`private void`	`clearNumber()`	The field number.
`private void`	`clearOneofIndex()`	The index of the field type in `Type.oneofs`, for message or enumeration types.
`private void`	`clearOptions()`	The protocol buffer options.
`private void`	`clearPacked()`	Whether to use alternative packed wire representation.
`private void`	`clearTypeUrl()`	The field type URL, without the scheme, for message or enumeration types.
`protected java.lang.Object`	`dynamicMethod(GeneratedMessageLite.MethodToInvoke method, java.lang.Object arg0, java.lang.Object arg1)`	A method that implements different types of operations described in `GeneratedMessageLite.MethodToInvoke`.
`private void`	`ensureOptionsIsMutable()`
`Field.Cardinality`	`getCardinality()`	The field cardinality.
`int`	`getCardinalityValue()`	The field cardinality.
`static Field`	`getDefaultInstance()`
`java.lang.String`	`getDefaultValue()`	The string value of the default value of this field.
`ByteString`	`getDefaultValueBytes()`	The string value of the default value of this field.
`java.lang.String`	`getJsonName()`	The field JSON name.
`ByteString`	`getJsonNameBytes()`	The field JSON name.
`Field.Kind`	`getKind()`	The field type.
`int`	`getKindValue()`	The field type.
`java.lang.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.
`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.
`java.lang.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.
`static Field.Builder`	`newBuilder()`
`static Field.Builder`	`newBuilder(Field prototype)`
`static Field`	`parseDelimitedFrom(java.io.InputStream input)`
`static Field`	`parseDelimitedFrom(java.io.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(java.io.InputStream input)`
`static Field`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Field`	`parseFrom(java.nio.ByteBuffer data)`
`static Field`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static Parser<Field>`	`parser()`
`private void`	`removeOptions(int index)`	The protocol buffer options.
`private void`	`setCardinality(Field.Cardinality value)`	The field cardinality.
`private void`	`setCardinalityValue(int value)`	The field cardinality.
`private void`	`setDefaultValue(java.lang.String value)`	The string value of the default value of this field.
`private void`	`setDefaultValueBytes(ByteString value)`	The string value of the default value of this field.
`private void`	`setJsonName(java.lang.String value)`	The field JSON name.
`private void`	`setJsonNameBytes(ByteString value)`	The field JSON name.
`private void`	`setKind(Field.Kind value)`	The field type.
`private void`	`setKindValue(int value)`	The field type.
`private void`	`setName(java.lang.String value)`	The field name.
`private void`	`setNameBytes(ByteString value)`	The field name.
`private void`	`setNumber(int value)`	The field number.
`private void`	`setOneofIndex(int value)`	The index of the field type in `Type.oneofs`, for message or enumeration types.
`private void`	`setOptions(int index, Option value)`	The protocol buffer options.
`private void`	`setPacked(boolean value)`	Whether to use alternative packed wire representation.
`private void`	`setTypeUrl(java.lang.String value)`	The field type URL, without the scheme, for message or enumeration types.
`private void`	`setTypeUrlBytes(ByteString value)`	The field type URL, without the scheme, for message or enumeration types.

Methods inherited from class com.google.protobuf.GeneratedMessageLite
buildMessageInfo, clearMemoizedHashCode, clearMemoizedSerializedSize, computeHashCode, createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstance, getDefaultInstanceForType, getMemoizedHashCode, getMemoizedSerializedSize, getMethodOrDie, getParserForType, getSerializedSize, getSerializedSize, hashCode, hashCodeIsNotMemoized, invokeOrDie, isInitialized, isInitialized, isMutable, makeImmutable, markImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newMutableInstance, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, setMemoizedHashCode, setMemoizedSerializedSize, toBuilder, toString, writeTo

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, newUninitializedMessageException, 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.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized

Field Detail

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 java.lang.String name_
```

TYPE_URL_FIELD_NUMBER
```
public static final int TYPE_URL_FIELD_NUMBER
```
See Also:

Constant Field Values

typeUrl_
```
private java.lang.String 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 Internal.ProtobufList<Option> options_

JSON_NAME_FIELD_NUMBER
```
public static final int JSON_NAME_FIELD_NUMBER
```
See Also:

Constant Field Values

jsonName_
```
private java.lang.String jsonName_
```

DEFAULT_VALUE_FIELD_NUMBER
```
public static final int DEFAULT_VALUE_FIELD_NUMBER
```
See Also:

Constant Field Values

defaultValue_
```
private java.lang.String defaultValue_
```

DEFAULT_INSTANCE

private static final Field DEFAULT_INSTANCE

PARSER

private static volatile Parser<Field> PARSER

Constructor Detail
- Field
```
private Field()
```

Method Detail

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.

setKindValue
```
private void setKindValue(int value)
```
```
 The field type.
 
```
.google.protobuf.Field.Kind kind = 1;
Parameters:

value - The enum numeric value on the wire for kind to set.

setKind
```
private void setKind(Field.Kind value)
```
```
 The field type.
 
```
.google.protobuf.Field.Kind kind = 1;
Parameters:

value - The kind to set.

clearKind

private void clearKind()

 The field type.

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

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.

setCardinalityValue
```
private void setCardinalityValue(int value)
```
```
 The field cardinality.
 
```
.google.protobuf.Field.Cardinality cardinality = 2;
Parameters:

value - The enum numeric value on the wire for cardinality to set.

setCardinality
```
private void setCardinality(Field.Cardinality value)
```
```
 The field cardinality.
 
```
.google.protobuf.Field.Cardinality cardinality = 2;
Parameters:

value - The cardinality to set.

clearCardinality
```
private void clearCardinality()
```
```
 The field cardinality.
 
```
.google.protobuf.Field.Cardinality cardinality = 2;

getNumber
```
public int getNumber()
```
```
 The field number.
 
```
int32 number = 3;
Specified by:

getNumber in interface FieldOrBuilder

Returns:

The number.

setNumber

private void setNumber(int value)

 The field number.

int32 number = 3;

Parameters:: value - The number to set.

clearNumber

private void clearNumber()

 The field number.

int32 number = 3;

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

setName

private void setName(java.lang.String value)

 The field name.

string name = 4;

Parameters:: value - The name to set.

clearName

private void clearName()

 The field name.

string name = 4;

setNameBytes

private void setNameBytes(ByteString value)

 The field name.

string name = 4;

Parameters:: value - The bytes for name to set.

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
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.

setTypeUrl

private void setTypeUrl(java.lang.String value)

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

string type_url = 6;

Parameters:: value - The typeUrl to set.

clearTypeUrl

private void clearTypeUrl()

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

string type_url = 6;

setTypeUrlBytes

private void setTypeUrlBytes(ByteString value)

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

string type_url = 6;

Parameters:: value - The bytes for typeUrl to set.

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.

setOneofIndex

private void setOneofIndex(int value)

 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;

Parameters:: value - The oneofIndex to set.

clearOneofIndex

private void clearOneofIndex()

 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;

getPacked
```
public boolean getPacked()
```
```
 Whether to use alternative packed wire representation.
 
```
bool packed = 8;
Specified by:

getPacked in interface FieldOrBuilder

Returns:

The packed.

setPacked

private void setPacked(boolean value)

 Whether to use alternative packed wire representation.

bool packed = 8;

Parameters:: value - The packed to set.

clearPacked

private void clearPacked()

 Whether to use alternative packed wire representation.

bool packed = 8;

getOptionsList
```
public java.util.List<Option> getOptionsList()
```
```
 The protocol buffer options.
 
```
repeated .google.protobuf.Option options = 9;
Specified by:

getOptionsList in interface FieldOrBuilder