Package org.apache.beam.sdk.coders

Class InstantCoder

java.lang.Object
org.apache.beam.sdk.coders.Coder<Instant>
org.apache.beam.sdk.coders.StructuredCoder<Instant>
org.apache.beam.sdk.coders.AtomicCoder<Instant>
org.apache.beam.sdk.coders.InstantCoder
All Implemented Interfaces:
Serializable
public class InstantCoder extends AtomicCoder<Instant>
A Coder for joda Instant that encodes it as a big endian Long shifted such that lexicographic ordering of the bytes corresponds to chronological order.
See Also:

  • Method Details

    • of

      public static InstantCoder of()

    • encode

      public void encode(Instant 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<Instant>
      Throws:
      CoderException - if the value could not be encoded for some reason
      IOException - if writing to the OutputStream fails for some reason

    • decode

      public Instant 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<Instant>
      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()
      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<Instant>

    • consistentWithEquals

      public boolean consistentWithEquals()
      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<Instant>
      Returns:
      true. This coder is injective.

    • isRegisterByteSizeObserverCheap

      public boolean isRegisterByteSizeObserverCheap(Instant 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<Instant>
      Returns:
      true. The byte size for a big endian long is a constant.

    • getEncodedElementByteSize

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

    • getEncodedTypeDescriptor

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