Class Field.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<Field.Builder>
com.google.protobuf.GeneratedMessage.Builder<Field.Builder>
com.google.protobuf.Field.Builder
All Implemented Interfaces:
FieldOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable
Enclosing class:
Field
public static final class Field.Builder extends GeneratedMessage.Builder<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

    • bitField0_

      private int bitField0_

    • kind_

      private int kind_

    • cardinality_

      private int cardinality_

    • number_

      private int number_

    • name_

      private Object name_

    • typeUrl_

      private Object typeUrl_

    • oneofIndex_

      private int oneofIndex_

    • packed_

      private boolean packed_

    • options_

      private List<Option> options_

    • optionsBuilder_

      private RepeatedFieldBuilder<Option, Option.Builder, OptionOrBuilder> optionsBuilder_

    • jsonName_

      private Object jsonName_

    • defaultValue_

      private Object defaultValue_

  • Constructor Details

  • Method Details

    • getDescriptor

      public static final Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Description copied from class: GeneratedMessage.Builder
      Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.
      Specified by:
      internalGetFieldAccessorTable in class GeneratedMessage.Builder<Field.Builder>

    • clear

      public Field.Builder clear()
      Description copied from class: GeneratedMessage.Builder
      Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
      Specified by:
      clear in interface Message.Builder
      Specified by:
      clear in interface MessageLite.Builder
      Overrides:
      clear in class GeneratedMessage.Builder<Field.Builder>

    • getDescriptorForType

      public Descriptors.Descriptor getDescriptorForType()
      Description copied from interface: Message.Builder
      Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().
      Specified by:
      getDescriptorForType in interface Message.Builder
      Specified by:
      getDescriptorForType in interface MessageOrBuilder
      Overrides:
      getDescriptorForType in class GeneratedMessage.Builder<Field.Builder>

    • 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

    • build

      public Field build()
      Description copied from interface: MessageLite.Builder
      Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.
      Specified by:
      build in interface Message.Builder
      Specified by:
      build in interface MessageLite.Builder

    • buildPartial

      public Field buildPartial()
      Description copied from interface: MessageLite.Builder
      Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.
      Specified by:
      buildPartial in interface Message.Builder
      Specified by:
      buildPartial in interface MessageLite.Builder

    • buildPartialRepeatedFields

      private void buildPartialRepeatedFields(Field result)

    • buildPartial0

      private void buildPartial0(Field result)

    • mergeFrom

      public Field.Builder mergeFrom(Message other)
      Description copied from interface: Message.Builder
      Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()).

      Merging occurs as follows. For each field:
      * For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
      * For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
      * For repeated fields, the elements in other are concatenated with the elements in this message.
      * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.

      This is equivalent to the Message::MergeFrom method in C++.

      Specified by:
      mergeFrom in interface Message.Builder
      Overrides:
      mergeFrom in class AbstractMessage.Builder<Field.Builder>

    • mergeFrom

      public Field.Builder mergeFrom(Field other)

    • 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 GeneratedMessage.Builder<Field.Builder>

    • mergeFrom

      public Field.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
      Description copied from interface: MessageLite.Builder
      Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.
      Specified by:
      mergeFrom in interface Message.Builder
      Specified by:
      mergeFrom in interface MessageLite.Builder
      Overrides:
      mergeFrom in class AbstractMessage.Builder<Field.Builder>
      Throws:
      IOException - an I/O error reading from the stream

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

    • setKindValue

      public Field.Builder 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.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • getKind

      public Field.Kind getKind()
      The field type.
      .google.protobuf.Field.Kind kind = 1;
      Specified by:
      getKind in interface FieldOrBuilder
      Returns:
      The kind.

    • setKind

      public Field.Builder setKind(Field.Kind value)
      The field type.
      .google.protobuf.Field.Kind kind = 1;
      Parameters:
      value - The kind to set.
      Returns:
      This builder for chaining.

    • clearKind

      public Field.Builder clearKind()
      The field type.
      .google.protobuf.Field.Kind kind = 1;
      Returns:
      This builder for chaining.

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

    • setCardinalityValue

      public Field.Builder 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.
      Returns:
      This builder for chaining.
      Throws:
      IllegalArgumentException - if UNRECOGNIZED is provided.

    • getCardinality

      public Field.Cardinality getCardinality()
      The field cardinality.
      .google.protobuf.Field.Cardinality cardinality = 2;
      Specified by:
      getCardinality in interface FieldOrBuilder
      Returns:
      The cardinality.

    • setCardinality

      public Field.Builder setCardinality(Field.Cardinality value)
      The field cardinality.
      .google.protobuf.Field.Cardinality cardinality = 2;
      Parameters:
      value - The cardinality to set.
      Returns:
      This builder for chaining.

    • clearCardinality

      public Field.Builder clearCardinality()
      The field cardinality.
      .google.protobuf.Field.Cardinality cardinality = 2;
      Returns:
      This builder for chaining.

    • getNumber

      public int getNumber()
      The field number.
      int32 number = 3;
      Specified by:
      getNumber in interface FieldOrBuilder
      Returns:
      The number.

    • setNumber

      public Field.Builder setNumber(int value)
      The field number.
      int32 number = 3;
      Parameters:
      value - The number to set.
      Returns:
      This builder for chaining.

    • clearNumber

      public Field.Builder clearNumber()
      The field number.
      int32 number = 3;
      Returns:
      This builder for chaining.

    • 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

      public Field.Builder setName(String value)
      The field name.
      string name = 4;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Field.Builder clearName()
      The field name.
      string name = 4;
      Returns:
      This builder for chaining.

    • setNameBytes

      public Field.Builder setNameBytes(ByteString value)
      The field name.
      string name = 4;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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

      public Field.Builder 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.
      Returns:
      This builder for chaining.

    • clearTypeUrl

      public Field.Builder clearTypeUrl()
      The field type URL, without the scheme, for message or enumeration
types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
      string type_url = 6;
      Returns:
      This builder for chaining.

    • setTypeUrlBytes

      public Field.Builder 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.
      Returns:
      This builder for chaining.

    • 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

      public Field.Builder 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.
      Returns:
      This builder for chaining.

    • clearOneofIndex

      public Field.Builder 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;
      Returns:
      This builder for chaining.

    • getPacked

      public boolean getPacked()
      Whether to use alternative packed wire representation.
      bool packed = 8;
      Specified by:
      getPacked in interface FieldOrBuilder
      Returns:
      The packed.

    • setPacked

      public Field.Builder setPacked(boolean value)
      Whether to use alternative packed wire representation.
      bool packed = 8;
      Parameters:
      value - The packed to set.
      Returns:
      This builder for chaining.

    • clearPacked

      public Field.Builder clearPacked()
      Whether to use alternative packed wire representation.
      bool packed = 8;
      Returns:
      This builder for chaining.

    • ensureOptionsIsMutable

      private void ensureOptionsIsMutable()

    • getOptionsList

      public 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

    • setOptions

      public Field.Builder setOptions(int index, Option value)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • setOptions

      public Field.Builder setOptions(int index, Option.Builder builderForValue)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • addOptions

      public Field.Builder addOptions(Option value)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • addOptions

      public Field.Builder addOptions(int index, Option value)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • addOptions

      public Field.Builder addOptions(Option.Builder builderForValue)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • addOptions

      public Field.Builder addOptions(int index, Option.Builder builderForValue)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • addAllOptions

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

    • clearOptions

      public Field.Builder clearOptions()
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • removeOptions

      public Field.Builder removeOptions(int index)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • getOptionsBuilder

      public Option.Builder getOptionsBuilder(int index)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • getOptionsOrBuilder

      public OptionOrBuilder getOptionsOrBuilder(int index)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;
      Specified by:
      getOptionsOrBuilder in interface FieldOrBuilder

    • getOptionsOrBuilderList

      public List<? extends OptionOrBuilder> getOptionsOrBuilderList()
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;
      Specified by:
      getOptionsOrBuilderList in interface FieldOrBuilder

    • addOptionsBuilder

      public Option.Builder addOptionsBuilder()
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • addOptionsBuilder

      public Option.Builder addOptionsBuilder(int index)
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • getOptionsBuilderList

      public List<Option.Builder> getOptionsBuilderList()
      The protocol buffer options.
      repeated .google.protobuf.Option options = 9;

    • internalGetOptionsFieldBuilder

      private RepeatedFieldBuilder<Option, Option.Builder, OptionOrBuilder> internalGetOptionsFieldBuilder()

    • 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

      public Field.Builder setJsonName(String value)
      The field JSON name.
      string json_name = 10;
      Parameters:
      value - The jsonName to set.
      Returns:
      This builder for chaining.

    • clearJsonName

      public Field.Builder clearJsonName()
      The field JSON name.
      string json_name = 10;
      Returns:
      This builder for chaining.

    • setJsonNameBytes

      public Field.Builder setJsonNameBytes(ByteString value)
      The field JSON name.
      string json_name = 10;
      Parameters:
      value - The bytes for jsonName to set.
      Returns:
      This builder for chaining.

    • 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

      public Field.Builder 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.
      Returns:
      This builder for chaining.

    • clearDefaultValue

      public Field.Builder clearDefaultValue()
      The string value of the default value of this field. Proto2 syntax only.
      string default_value = 11;
      Returns:
      This builder for chaining.

    • setDefaultValueBytes

      public Field.Builder 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.
      Returns:
      This builder for chaining.