com.google.cloud.dataflow.sdk.coders

Class InstantCoder

java.lang.Object

com.google.cloud.dataflow.sdk.coders.StandardCoder<T>

com.google.cloud.dataflow.sdk.coders.DeterministicStandardCoder<T>

com.google.cloud.dataflow.sdk.coders.AtomicCoder<org.joda.time.Instant>

com.google.cloud.dataflow.sdk.coders.InstantCoder

All Implemented Interfaces:

Coder<org.joda.time.Instant>, Serializable

public class InstantCoder
extends AtomicCoder<org.joda.time.Instant>

A InstantCoder is a Coder for a joda Instant.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.cloud.dataflow.sdk.coders.Coder

Coder.Context, Coder.NonDeterministicException

Method Summary

Modifier and Type	Method and Description
boolean	consistentWithEquals() Returns true if 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).
org.joda.time.Instant	decode(InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(org.joda.time.Instant value, OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
boolean	isRegisterByteSizeObserverCheap(org.joda.time.Instant value, Coder.Context context) StandardCoder requires elements to be fully encoded and copied into a byte stream to determine the byte size of the element, which is considered expensive.
static InstantCoder	of()
void	registerByteSizeObserver(org.joda.time.Instant value, com.google.cloud.dataflow.sdk.util.common.ElementByteSizeObserver observer, Coder.Context context) Notifies observer about the byte size of the encoded value using this coder.

Methods inherited from class com.google.cloud.dataflow.sdk.coders.AtomicCoder

getCoderArguments, getInstanceComponents

Methods inherited from class com.google.cloud.dataflow.sdk.coders.DeterministicStandardCoder

verifyDeterministic

Methods inherited from class com.google.cloud.dataflow.sdk.coders.StandardCoder

asCloudObject, equals, getAllowedEncodings, getComponents, getEncodedElementByteSize, getEncodingId, hashCode, structuralValue, toString, 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(org.joda.time.Instant value,
                   OutputStream outStream,
                   Coder.Context context)
            throws CoderException,
                   IOException

Description copied from interface: Coder

Encodes the given value of type T onto the given output stream in the given context.

Throws:

CoderException - if the value could not be encoded for some reason

IOException - if writing to the OutputStream fails for some reason

decode

public org.joda.time.Instant decode(InputStream inStream,
                                    Coder.Context context)
                             throws CoderException,
                                    IOException

Description copied from interface: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value.

Throws:

CoderException - if the value could not be decoded for some reason

IOException - if reading from the InputStream fails for some reason

consistentWithEquals

public boolean consistentWithEquals()

Description copied from interface: Coder

Returns true if 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). In other words, encoding is injective.

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.

Specified by:

consistentWithEquals in interface Coder<org.joda.time.Instant>

Overrides:

consistentWithEquals in class StandardCoder<org.joda.time.Instant>

isRegisterByteSizeObserverCheap

public boolean isRegisterByteSizeObserverCheap(org.joda.time.Instant value,
                                               Coder.Context context)

Description copied from class: StandardCoder

StandardCoder requires elements to be fully encoded and copied into a byte stream to determine the byte size of the element, which is considered expensive.

Specified by:

isRegisterByteSizeObserverCheap in interface Coder<org.joda.time.Instant>

Overrides:

isRegisterByteSizeObserverCheap in class StandardCoder<org.joda.time.Instant>

registerByteSizeObserver

public void registerByteSizeObserver(org.joda.time.Instant value,
                                     com.google.cloud.dataflow.sdk.util.common.ElementByteSizeObserver observer,
                                     Coder.Context context)
                              throws Exception

Description copied from class: StandardCoder

Notifies observer about the byte size of the encoded value using this coder. Calls StandardCoder.getEncodedElementByteSize(T, com.google.cloud.dataflow.sdk.coders.Coder.Context) and notifies observer using ElementByteSizeObserver.update(Object).

Specified by:

registerByteSizeObserver in interface Coder<org.joda.time.Instant>

Overrides:

registerByteSizeObserver in class StandardCoder<org.joda.time.Instant>

Throws:

Exception