Package org.apache.beam.sdk.coders

Class DurationCoder

  • All Implemented Interfaces:
    java.io.Serializable
    public class DurationCoder
extends AtomicCoder<org.joda.time.ReadableDuration>
    A Coder that encodes a joda Duration as a Long using the format of VarLongCoder.
    See Also:
    Serialized Form

    • Method Detail

      • encode

        public void encode​(org.joda.time.ReadableDuration value,
                   java.io.OutputStream outStream)
            throws CoderException,
                   java.io.IOException
        Description copied from class: Coder
        Encodes the given value of type T onto the given output stream.
        Specified by:
        encode in class Coder<org.joda.time.ReadableDuration>
        Throws:
        CoderException - if the value could not be encoded for some reason
        java.io.IOException - if writing to the OutputStream fails for some reason

      • decode

        public org.joda.time.ReadableDuration decode​(java.io.InputStream inStream)
                                      throws CoderException,
                                             java.io.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.
        Specified by:
        decode in class Coder<org.joda.time.ReadableDuration>
        Throws:
        CoderException - if the value could not be decoded for some reason
        java.io.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<org.joda.time.ReadableDuration>

      • 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<org.joda.time.ReadableDuration>
        Returns:
        true. This coder is injective.

      • registerByteSizeObserver

        public void registerByteSizeObserver​(org.joda.time.ReadableDuration value,
                                     ElementByteSizeObserver observer)
                              throws java.lang.Exception
        Description copied from class: Coder
        Notifies the ElementByteSizeObserver about the byte size of the encoded value using this Coder.

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

        By default, this notifies observer about the byte size of the encoded value using this coder as returned by Coder.getEncodedElementByteSize(T).

        Overrides:
        registerByteSizeObserver in class Coder<org.joda.time.ReadableDuration>
        Throws:
        java.lang.Exception