org.apache.beam.sdk.coders

Class InstantCoder

java.lang.Object

org.apache.beam.sdk.coders.Coder<T>

org.apache.beam.sdk.coders.StructuredCoder<T>

org.apache.beam.sdk.coders.AtomicCoder<Instant>

org.apache.beam.sdk.coders.InstantCoder

All Implemented Interfaces:

java.io.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:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.sdk.coders.Coder

Coder.Context, Coder.NonDeterministicException

Method Summary

Modifier and Type	Method and Description
boolean	consistentWithEquals() Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).
Instant	decode(java.io.InputStream inStream) Decodes a value of type T from the given input stream in the given context.
void	encode(Instant value, java.io.OutputStream outStream) Encodes the given value of type T onto the given output stream.
TypeDescriptor<Instant>	getEncodedTypeDescriptor() Returns the TypeDescriptor for the type encoded.
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).
static InstantCoder	of()
void	registerByteSizeObserver(Instant value, org.apache.beam.sdk.util.common.ElementByteSizeObserver observer) Notifies the ElementByteSizeObserver about the byte size of the encoded value using this Coder.
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.

Methods inherited from class org.apache.beam.sdk.coders.AtomicCoder

equals, getCoderArguments, getComponents, hashCode

Methods inherited from class org.apache.beam.sdk.coders.StructuredCoder

structuralValue, toString

Methods inherited from class org.apache.beam.sdk.coders.Coder

decode, encode, getEncodedElementByteSize, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static InstantCoder of()

encode

public void encode(Instant 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<Instant>

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 Instant 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<Instant>

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<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 StructuredCoder<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.

registerByteSizeObserver

public void registerByteSizeObserver(Instant value,
                                     org.apache.beam.sdk.util.common.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<Instant>

Throws:

java.lang.Exception

getEncodedTypeDescriptor

public TypeDescriptor<Instant> getEncodedTypeDescriptor()

Description copied from class: Coder

Returns the TypeDescriptor for the type encoded.

Overrides:

getEncodedTypeDescriptor in class StructuredCoder<Instant>