Class Field

java.lang.Object
com.google.protobuf.AbstractMessageLite<Field, Field.Builder>
com.google.protobuf.GeneratedMessageLite<Field, Field.Builder>
com.google.protobuf.Field
All Implemented Interfaces:
FieldOrBuilder, MessageLite, MessageLiteOrBuilder
@Generated public final class Field extends GeneratedMessageLite<Field, Field.Builder> implements FieldOrBuilder
A single field of a message type.

New usages of this message as an alternative to FieldDescriptorProto are
strongly discouraged. This message does not reliability preserve all
information necessary to model the schema and preserve semantics. Instead
make use of FileDescriptorSet which preserves the necessary information.
Protobuf type google.protobuf.Field

  • Field Details

    • KIND_FIELD_NUMBER

      public static final int KIND_FIELD_NUMBER
      See Also:

    • kind_

      private int kind_

    • CARDINALITY_FIELD_NUMBER

      public static final int CARDINALITY_FIELD_NUMBER
      See Also:

    • cardinality_

      private int cardinality_

    • NUMBER_FIELD_NUMBER

      public static final int NUMBER_FIELD_NUMBER
      See Also:

    • number_

      private int number_

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • name_

      private String name_

    • TYPE_URL_FIELD_NUMBER

      public static final int TYPE_URL_FIELD_NUMBER
      See Also:

    • typeUrl_

      private String typeUrl_

    • ONEOF_INDEX_FIELD_NUMBER

      public static final int ONEOF_INDEX_FIELD_NUMBER
      See Also:

    • oneofIndex_

      private int oneofIndex_

    • PACKED_FIELD_NUMBER

      public static final int PACKED_FIELD_NUMBER
      See Also:

    • packed_

      private boolean packed_

    • OPTIONS_FIELD_NUMBER

      public static final int OPTIONS_FIELD_NUMBER
      See Also:

    • options_

      private Internal.ProtobufList<Option> options_

    • JSON_NAME_FIELD_NUMBER

      public static final int JSON_NAME_FIELD_NUMBER
      See Also:

    • jsonName_

      private String jsonName_

    • DEFAULT_VALUE_FIELD_NUMBER

      public static final int DEFAULT_VALUE_FIELD_NUMBER
      See Also:

    • defaultValue_

      private String defaultValue_

    • DEFAULT_INSTANCE

      private static final Field DEFAULT_INSTANCE

    • PARSER

      private static volatile Parser<Field> PARSER

  • Constructor Details

    • Field

      private Field()

  • Method Details

    • 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 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(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 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(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 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;

    • 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;

    • ensureOptionsIsMutable

      private void ensureOptionsIsMutable()

    • setOptions

      private void setOptions(int index, Option value)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • addOptions

      private void addOptions(Option value)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • addOptions

      private void addOptions(int index, Option value)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • addAllOptions

      private void addAllOptions(Iterable<? extends Option> values)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • clearOptions

      private void clearOptions()
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • removeOptions

      private void removeOptions(int index)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

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

    • setJsonName

      private void setJsonName(String value)
      The field JSON name.
      string json_name = 10;
      Parameters:
      value - The jsonName to set.

    • clearJsonName

      private void clearJsonName()
      The field JSON name.
      string json_name = 10;

    • setJsonNameBytes

      private void setJsonNameBytes(ByteString value)
      The field JSON name.
      string json_name = 10;
      Parameters:
      value - The bytes for jsonName to set.

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

    • setDefaultValue

      private void setDefaultValue(String value)
      The string value of the default value of this field. Proto2 syntax only.
      string default_value = 11;
      Parameters:
      value - The defaultValue to set.

    • clearDefaultValue

      private void clearDefaultValue()
      The string value of the default value of this field. Proto2 syntax only.
      string default_value = 11;

    • setDefaultValueBytes

      private void setDefaultValueBytes(ByteString value)
      The string value of the default value of this field. Proto2 syntax only.
      string default_value = 11;
      Parameters:
      value - The bytes for defaultValue to set.

    • 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

    • newBuilder

      public static Field.Builder newBuilder()

    • newBuilder

      public static Field.Builder newBuilder(Field prototype)

    • dynamicMethod

      protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Description copied from class: GeneratedMessageLite
      A method that implements different types of operations described in GeneratedMessageLite.MethodToInvoke. These different kinds of operations are required to implement message-level operations for builders in the runtime. This method bundles those operations to reduce the generated methods count.
      • NEW_INSTANCE returns a new instance of the protocol buffer that has not yet been made immutable. See MAKE_IMMUTABLE.
      • IS_INITIALIZED returns null for false and the default instance for true. It doesn't use or modify any memoized value.
      • GET_MEMOIZED_IS_INITIALIZED returns the memoized isInitialized byte value.
      • SET_MEMOIZED_IS_INITIALIZED sets the memoized isInitialized byte value to 1 if the first parameter is not null, or to 0 if the first parameter is null.
      • NEW_BUILDER returns a BuilderType instance.
      This method, plus the implementation of the Builder, enables the Builder class to be proguarded away entirely on Android.

      For use by generated code only.

      Specified by:
      dynamicMethod in class GeneratedMessageLite<Field, Field.Builder>

    • getDefaultInstance

      public static Field getDefaultInstance()

    • parser

      public static Parser<Field> parser()