Package com.google.protobuf

Class 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 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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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.
      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)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      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​(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 Field parseFrom​(java.nio.ByteBuffer data)  
      static Field parseFrom​(java.nio.ByteBuffer data, 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, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, 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.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance 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
        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.

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

      • 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

      • 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 com.google.protobuf.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 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
        Returns:
        The bytes for defaultValue.

      • 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

      • 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