Package org.apache.beam.sdk.coders

Class BooleanCoder

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

  • Constructor Details

    • BooleanCoder

      public BooleanCoder()

  • Method Details

    • of

      public static BooleanCoder of()
      Returns the singleton instance of BooleanCoder.

    • encode

      public void encode(Boolean value, OutputStream os) throws 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<Boolean>
      Throws:
      IOException - if writing to the OutputStream fails for some reason

    • decode

      public Boolean decode(InputStream is) throws 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<Boolean>
      Throws:
      IOException - if reading from the InputStream fails for some reason

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

    • isRegisterByteSizeObserverCheap

      public boolean isRegisterByteSizeObserverCheap(Boolean value)
      Description copied from class: Coder
      Returns whether Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver) cheap enough to call for every element, that is, if this Coder can calculate the byte size of the element to be coded in roughly constant time (or lazily).

      Not intended to be called by user code, but instead by PipelineRunner implementations.

      By default, returns false. The default Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver) implementation invokes Coder.getEncodedElementByteSize(T) which requires re-encoding an element unless it is overridden. This is considered expensive.

      Overrides:
      isRegisterByteSizeObserverCheap in class Coder<Boolean>

    • getEncodedElementByteSize

      protected long getEncodedElementByteSize(Boolean value) throws Exception
      Description copied from class: Coder
      Returns the size in bytes of the encoded value using this coder.
      Overrides:
      getEncodedElementByteSize in class Coder<Boolean>
      Throws:
      Exception