Package org.apache.beam.sdk.coders

Class BitSetCoder

java.lang.Object
org.apache.beam.sdk.coders.Coder<BitSet>
org.apache.beam.sdk.coders.StructuredCoder<BitSet>
org.apache.beam.sdk.coders.AtomicCoder<BitSet>
org.apache.beam.sdk.coders.BitSetCoder
All Implemented Interfaces:
Serializable
public class BitSetCoder extends AtomicCoder<BitSet>
Coder for BitSet.
See Also:

  • Method Details

    • of

      public static BitSetCoder of()

    • encode

      public void encode(BitSet value, OutputStream outStream) throws CoderException, IOException
      Description copied from class: Coder
      Encodes the given value of type T onto the given output stream. Multiple elements can be encoded next to each other on the output stream, each coder should encode information to know how many bytes to read when decoding. A common approach is to prefix the encoding with the element's encoded length.
      Specified by:
      encode in class Coder<BitSet>
      Throws:
      CoderException - if the value could not be encoded for some reason
      IOException - if writing to the OutputStream fails for some reason

    • encode

      public void encode(BitSet value, OutputStream outStream, Coder.Context context) throws CoderException, IOException
      Description copied from class: Coder
      Encodes the given value of type T onto the given output stream in the given context.
      Overrides:
      encode in class Coder<BitSet>
      Throws:
      CoderException - if the value could not be encoded for some reason
      IOException - if writing to the OutputStream fails for some reason

    • decode

      public BitSet decode(InputStream inStream) throws CoderException, IOException
      Description copied from class: Coder
      Decodes a value of type T from the given input stream in the given context. Returns the decoded value. Multiple elements can be encoded next to each other on the input stream, each coder should encode information to know how many bytes to read when decoding. A common approach is to prefix the encoding with the element's encoded length.
      Specified by:
      decode in class Coder<BitSet>
      Throws:
      CoderException - if the value could not be decoded for some reason
      IOException - if reading from the InputStream fails for some reason

    • decode

      public BitSet decode(InputStream inStream, Coder.Context context) throws CoderException, IOException
      Description copied from class: Coder
      Decodes a value of type T from the given input stream in the given context. Returns the decoded value.
      Overrides:
      decode in class Coder<BitSet>
      Throws:
      CoderException - if the value could not be decoded for some reason
      IOException - if reading from the InputStream fails for some reason

    • verifyDeterministic

      public void verifyDeterministic() throws Coder.NonDeterministicException
      Description copied from class: AtomicCoder
      Throw Coder.NonDeterministicException if the coding is not deterministic.

      In order for a Coder to be considered deterministic, the following must be true:

      • two values that compare as equal (via Object.equals() or Comparable.compareTo(), if supported) have the same encoding.
      • the Coder always produces a canonical encoding, which is the same for an instance of an object even if produced on different computers at different times.
      .

      Unless overridden, does not throw. An AtomicCoder is presumed to be deterministic

      Overrides:
      verifyDeterministic in class AtomicCoder<BitSet>
      Throws:
      Coder.NonDeterministicException - if overridden to indicate that this subclass of AtomicCoder is not deterministic

    • consistentWithEquals

      public boolean consistentWithEquals()
      Description copied from class: Coder
      Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).

      Whenever the encoded bytes of two values are equal, then the original values are equal according to Objects.equals(). Note that this is well-defined for null.

      This condition is most notably false for arrays. More generally, this condition is false whenever equals() compares object identity, rather than performing a semantic/structural comparison.

      By default, returns false.

      Overrides:
      consistentWithEquals in class Coder<BitSet>