Package org.apache.beam.sdk.coders

Class VoidCoder

java.lang.Object
org.apache.beam.sdk.coders.Coder<Void>
org.apache.beam.sdk.coders.StructuredCoder<Void>
org.apache.beam.sdk.coders.AtomicCoder<@Nullable Void>
org.apache.beam.sdk.coders.VoidCoder
All Implemented Interfaces:
Serializable
public class VoidCoder extends AtomicCoder<@Nullable Void>
A Coder for Void. Uses zero bytes per Void.
See Also:

  • Method Details

    • of

      public static VoidCoder of()

    • encode

      public void encode(Void value, OutputStream outStream)
      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<Void>

    • decode

      public @Nullable Void decode(InputStream inStream)
      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<Void>

    • verifyDeterministic

      public void verifyDeterministic()
      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<@Nullable Void>

    • structuralValue

      public Object structuralValue(Void value)
      Description copied from class: Coder
      Returns an object with an Object.equals() method that represents structural equality on the argument.

      For any two values x and y of type T, if their encoded bytes are the same, then it must be the case that structuralValue(x).equals(structuralValue(y)).

      Most notably:

      • The structural value for an array coder should perform a structural comparison of the contents of the arrays, rather than the default behavior of comparing according to object identity.
      • The structural value for a coder accepting null should be a proper object with an equals() method, even if the input value is null.

      See also Coder.consistentWithEquals().

      By default, if this coder is Coder.consistentWithEquals(), and the value is not null, returns the provided object. Otherwise, encodes the value into a byte[], and returns an object that performs array equality on the encoded bytes.

      Overrides:
      structuralValue in class Coder<Void>

    • isRegisterByteSizeObserverCheap

      public boolean isRegisterByteSizeObserverCheap(Void value)
      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<Void>
      Returns:
      true. getEncodedElementByteSize(java.lang.Void) runs in constant time.

    • getEncodedTypeDescriptor

      public TypeDescriptor<Void> getEncodedTypeDescriptor()
      Description copied from class: Coder
      Returns the TypeDescriptor for the type encoded.
      Overrides:
      getEncodedTypeDescriptor in class Coder<Void>

    • getEncodedElementByteSize

      protected long getEncodedElementByteSize(Void 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<Void>
      Throws:
      Exception