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

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

All Implemented Interfaces:

Coder<Instant>, java.io.Serializable

public class InstantCoder
extends AtomicCoder<Instant>

A InstantCoder encodes 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

Methods

Modifier and Type	Method and Description
boolean	consistentWithEquals() Returns true if the encoded bytes of two objects are equal only when they are also equal according to Object.equals().
Instant	decode(java.io.InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(Instant value, java.io.OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
boolean	isDeterministic() Deprecated.
static InstantCoder	of()
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.

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

getCoderArguments, getInstanceComponents

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

asCloudObject, equals, getComponents, getEncodedElementByteSize, hashCode, isRegisterByteSizeObserverCheap, registerByteSizeObserver, 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(Instant value,
          java.io.OutputStream outStream,
          Coder.Context context)
            throws CoderException,
                   java.io.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

java.io.IOException - if writing to the OutputStream fails for some reason

decode

public Instant decode(java.io.InputStream inStream,
             Coder.Context context)
               throws CoderException,
                      java.io.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

java.io.IOException - if reading from the InputStream fails for some reason

isDeterministic

@Deprecated
public boolean isDeterministic()

Deprecated.

Description copied from interface: Coder

Returns true if the coding is 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.

verifyDeterministic

public void verifyDeterministic()

Description copied from interface: Coder

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.

Specified by:

verifyDeterministic in interface Coder<Instant>

Overrides:

verifyDeterministic in class StandardCoder<Instant>

consistentWithEquals

public boolean consistentWithEquals()

Description copied from interface: Coder

Returns true if the encoded bytes of two objects are equal only when they are also equal according to Object.equals(). (and also implements a compatible Object.hasCode())

This most notably false for arrays. It will generally be false when Object.equals() compares object identity, rather than performing a semantic/structural comparison.

Specified by:

consistentWithEquals in interface Coder<Instant>

Overrides:

consistentWithEquals in class StandardCoder<Instant>