Field

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals (java.lang.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.
`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.
`static Descriptors.Descriptor`	`getDescriptor ()`
`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.
`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.
`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.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields ()` Get the `UnknownFieldSet` for this message.
`int`	`hashCode ()` Returns the hash code value for this message.
`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.
`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 (java.nio.ByteBuffer data)`
`static Field`	`parseFrom (java.nio.ByteBuffer 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 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 com.google.protobuf.GeneratedMessageV3
getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from class com.google.protobuf. AbstractMessage
findInitializationErrors , getInitializationErrorString , toString

Methods inherited from class com.google.protobuf. AbstractMessageLite
toByteArray , toByteString , writeDelimitedTo , writeTo

Methods inherited from class java.lang.Object
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()
```
    Description copied from interface: MessageOrBuilder
    
    Get the UnknownFieldSet for this message.
    
    Specified by:
    
    getUnknownFields in interface MessageOrBuilder
    
    Overrides:
    
    getUnknownFields in class com.google.protobuf.GeneratedMessageV3
  - getDescriptor
```
public static final  Descriptors.Descriptor 
 getDescriptor()
```
  - 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 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.
  - 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.
  - 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 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
    
    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 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
    
    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 com.google.protobuf.GeneratedMessageV3
  - writeTo
```
public void writeTo( CodedOutputStream 
 output)
             throws java.io.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 com.google.protobuf.GeneratedMessageV3
    
    Throws:
    
    java.io.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.
    
    Specified by:
    
    getSerializedSize in interface MessageLite
    
    Overrides:
    
    getSerializedSize in class com.google.protobuf.GeneratedMessageV3
  - equals
```
public boolean equals(java.lang.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(java.nio.ByteBuffer data)
                       throws InvalidProtocolBufferException 
```
    Throws:
    
    InvalidProtocolBufferException
  - parseFrom
```
public static  Field 
 parseFrom(java.nio.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(java.io.InputStream input)
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static  Field 
 parseFrom(java.io.InputStream input, 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, ExtensionRegistryLite 
 extensionRegistry)
                                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static  Field 
 parseFrom( CodedInputStream 
 input)
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseFrom
```
public static  Field 
 parseFrom( CodedInputStream 
 input, ExtensionRegistryLite 
 extensionRegistry)
                       throws java.io.IOException
```
    Throws:
    
    java.io.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
  - 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 com.google.protobuf.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

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Create a Mobile Website

View Site in Mobile | Classic

Class Field

Nested Class Summary

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

Field Summary

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf. AbstractMessage

Methods inherited from class com.google.protobuf. AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf. MessageOrBuilder

Methods inherited from interface com.google.protobuf. MessageLite

Field Detail

KIND_FIELD_NUMBER

CARDINALITY_FIELD_NUMBER

NUMBER_FIELD_NUMBER

NAME_FIELD_NUMBER

TYPE_URL_FIELD_NUMBER

ONEOF_INDEX_FIELD_NUMBER

PACKED_FIELD_NUMBER

OPTIONS_FIELD_NUMBER

JSON_NAME_FIELD_NUMBER

DEFAULT_VALUE_FIELD_NUMBER

Method Detail

getUnknownFields

getDescriptor

getKindValue

getKind

getCardinalityValue

getCardinality

getNumber

getName

getNameBytes

getTypeUrl

getTypeUrlBytes

getOneofIndex

getPacked

getOptionsList

getOptionsOrBuilderList

getOptionsCount

getOptions

getOptionsOrBuilder

getJsonName

getJsonNameBytes

getDefaultValue

getDefaultValueBytes

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType