Package com.google.firestore.v1

Class BitSequence.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BitSequence.Builder>
com.google.firestore.v1.BitSequence.Builder
All Implemented Interfaces:
BitSequenceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
BitSequence
public static final class BitSequence.Builder extends com.google.protobuf.GeneratedMessage.Builder<BitSequence.Builder> implements BitSequenceOrBuilder
 A sequence of bits, encoded in a byte array.

 Each byte in the `bitmap` byte array stores 8 bits of the sequence. The only
 exception is the last byte, which may store 8 _or fewer_ bits. The `padding`
 defines the number of bits of the last byte to be ignored as "padding". The
 values of these "padding" bits are unspecified and must be ignored.

 To retrieve the first bit, bit 0, calculate: `(bitmap[0] & 0x01) != 0`.
 To retrieve the second bit, bit 1, calculate: `(bitmap[0] & 0x02) != 0`.
 To retrieve the third bit, bit 2, calculate: `(bitmap[0] & 0x04) != 0`.
 To retrieve the fourth bit, bit 3, calculate: `(bitmap[0] & 0x08) != 0`.
 To retrieve bit n, calculate: `(bitmap[n / 8] & (0x01 << (n % 8))) != 0`.

 The "size" of a `BitSequence` (the number of bits it contains) is calculated
 by this formula: `(bitmap.length * 8) - padding`.
Protobuf type google.firestore.v1.BitSequence

  • Method Summary

    Modifier and Type
    Method
    Description
    BitSequence
    build()
     
    BitSequence
    buildPartial()
     
    BitSequence.Builder
    clear()
     
    BitSequence.Builder
    clearBitmap()
    The bytes that encode the bit sequence.
    BitSequence.Builder
    clearPadding()
    The number of bits of the last byte in `bitmap` to ignore as "padding".
    com.google.protobuf.ByteString
    getBitmap()
    The bytes that encode the bit sequence.
    BitSequence
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    int
    getPadding()
    The number of bits of the last byte in `bitmap` to ignore as "padding".
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    BitSequence.Builder
    mergeFrom(BitSequence other)
     
    BitSequence.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    BitSequence.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    BitSequence.Builder
    setBitmap(com.google.protobuf.ByteString value)
    The bytes that encode the bit sequence.
    BitSequence.Builder
    setPadding(int value)
    The number of bits of the last byte in `bitmap` to ignore as "padding".

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<BitSequence.Builder>

    • clear

      public BitSequence.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<BitSequence.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<BitSequence.Builder>

    • getDefaultInstanceForType

      public BitSequence getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public BitSequence build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public BitSequence buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public BitSequence.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BitSequence.Builder>

    • mergeFrom

      public BitSequence.Builder mergeFrom(BitSequence other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<BitSequence.Builder>

    • mergeFrom

      public BitSequence.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BitSequence.Builder>
      Throws:
      IOException

    • getBitmap

      public com.google.protobuf.ByteString getBitmap()
       The bytes that encode the bit sequence.
 May have a length of zero.
      bytes bitmap = 1;
      Specified by:
      getBitmap in interface BitSequenceOrBuilder
      Returns:
      The bitmap.

    • setBitmap

      public BitSequence.Builder setBitmap(com.google.protobuf.ByteString value)
       The bytes that encode the bit sequence.
 May have a length of zero.
      bytes bitmap = 1;
      Parameters:
      value - The bitmap to set.
      Returns:
      This builder for chaining.

    • clearBitmap

      public BitSequence.Builder clearBitmap()
       The bytes that encode the bit sequence.
 May have a length of zero.
      bytes bitmap = 1;
      Returns:
      This builder for chaining.

    • getPadding

      public int getPadding()
       The number of bits of the last byte in `bitmap` to ignore as "padding".
 If the length of `bitmap` is zero, then this value must be `0`.
 Otherwise, this value must be between 0 and 7, inclusive.
      int32 padding = 2;
      Specified by:
      getPadding in interface BitSequenceOrBuilder
      Returns:
      The padding.

    • setPadding

      public BitSequence.Builder setPadding(int value)
       The number of bits of the last byte in `bitmap` to ignore as "padding".
 If the length of `bitmap` is zero, then this value must be `0`.
 Otherwise, this value must be between 0 and 7, inclusive.
      int32 padding = 2;
      Parameters:
      value - The padding to set.
      Returns:
      This builder for chaining.

    • clearPadding

      public BitSequence.Builder clearPadding()
       The number of bits of the last byte in `bitmap` to ignore as "padding".
 If the length of `bitmap` is zero, then this value must be `0`.
 Otherwise, this value must be between 0 and 7, inclusive.
      int32 padding = 2;
      Returns:
      This builder for chaining.