com.google.cloud.dataflow.sdk.coders

Class SerializableCoder<T extends Serializable>

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<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>, Serializable

public class SerializableCoder<T extends Serializable>
extends AtomicCoder<T>

A SerializableCoder is a Coder for a Java class that implements Serializable.

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

Field Summary

Fields

Modifier and Type	Field and Description
static CoderProvider	PROVIDER A CoderProvider that constructs a SerializableCoder for any class that implements serializable.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SerializableCoder(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(InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(T value, OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
boolean	equals(Object other)
Class<T>	getRecordType()
int	hashCode()
static <T extends Serializable> SerializableCoder<T>	of(Class<T> clazz) Returns a SerializableCoder instance for the provided element class.
static SerializableCoder<?>	of(String classType)
void	verifyDeterministic() As a DeterministicStandardCoder is presumed deterministic, this method does nothing.

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

getCoderArguments, getInstanceComponents

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

consistentWithEquals, getComponents, getEncodedElementByteSize, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, toString, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Field Detail

PROVIDER

public static final CoderProvider PROVIDER

A CoderProvider that constructs a SerializableCoder for any class that implements serializable.

Constructor Detail

SerializableCoder

protected SerializableCoder(Class<T> type)

Method Detail

of

public static <T extends Serializable> SerializableCoder<T> of(Class<T> clazz)

Returns a SerializableCoder instance for the provided element class.

Type Parameters:

T - the element type

of

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

Throws:

ClassNotFoundException

getRecordType

public Class<T> getRecordType()

encode

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

Description copied from interface: Coder

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

Throws:

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(InputStream inStream,
       Coder.Context context)
                              throws 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:

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

Overrides:

asCloudObject in class StandardCoder<T extends Serializable>

verifyDeterministic

public void verifyDeterministic()
                         throws Coder.NonDeterministicException

Description copied from class: DeterministicStandardCoder

As a DeterministicStandardCoder is presumed deterministic, this method does nothing.

Specified by:

verifyDeterministic in interface Coder<T extends Serializable>

Overrides:

verifyDeterministic in class DeterministicStandardCoder<T extends Serializable>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.

equals

public boolean equals(Object other)

Overrides:

equals in class StandardCoder<T extends Serializable>

hashCode

public int hashCode()

Overrides:

hashCode in class StandardCoder<T extends Serializable>