com.google.cloud.dataflow.sdk.coders

Class SerializableCoder<T extends java.io.Serializable>

java.lang.Object

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

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

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

Type Parameters:

T - the type of elements handled by this coder

All Implemented Interfaces:

Coder<T>, java.io.Serializable

public class SerializableCoder<T extends java.io.Serializable>
extends AtomicCoder<T>

An encoder of Serializable objects. To use, specify the coder type on a PCollection.

 PCollection<MyRecord> records =
       foo.apply(...).setCoder(SerializableCoder.of(MyRecord.class));
 
 

SerializableCoder does not guarantee a deterministic encoding, as Java Serialization may produce different binary encodings for two equivalent objects.

See Also:

Serialized Form

Nested Class Summary

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

Coder.Context, Coder.NonDeterministicException

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SerializableCoder(java.lang.Class<T> type)

Method Summary

Methods

Modifier and Type	Method and Description
com.google.cloud.dataflow.sdk.util.CloudObject	asCloudObject() Returns the CloudObject that represents this Coder.
T	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(T 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	equals(java.lang.Object other)
java.lang.Class<T>	getRecordType()
boolean	isDeterministic() Deprecated.
static <T extends java.io.Serializable> SerializableCoder<T>	of(java.lang.Class<T> type) Returns a SerializableCoder instance for the provided element type.
static SerializableCoder<?>	of(java.lang.String classType)
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

getComponents, getEncodedElementByteSize, hashCode, isRegisterByteSizeObserverCheap, registerByteSizeObserver, toString, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializableCoder

protected SerializableCoder(java.lang.Class<T> type)

Method Detail

of

public static <T extends java.io.Serializable> SerializableCoder<T> of(java.lang.Class<T> type)

Returns a SerializableCoder instance for the provided element type.

Type Parameters:

T - the element type

of

public static SerializableCoder<?> of(java.lang.String classType)
                               throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

getRecordType

public java.lang.Class<T> getRecordType()

encode

public void encode(T value,
          java.io.OutputStream outStream,
          Coder.Context context)
            throws java.io.IOException,
                   CoderException

Description copied from interface: Coder

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

Throws:

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

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

decode

public T decode(java.io.InputStream inStream,
       Coder.Context context)
                                      throws java.io.IOException,
                                             CoderException

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:

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

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

asCloudObject

public com.google.cloud.dataflow.sdk.util.CloudObject asCloudObject()

Description copied from interface: Coder

Returns the CloudObject that represents this Coder.

Specified by:

asCloudObject in interface Coder<T extends java.io.Serializable>

Overrides:

asCloudObject in class StandardCoder<T extends java.io.Serializable>

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 which 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()
                         throws Coder.NonDeterministicException

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 which 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<T extends java.io.Serializable>

Overrides:

verifyDeterministic in class StandardCoder<T extends java.io.Serializable>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class StandardCoder<T extends java.io.Serializable>