com.google.cloud.dataflow.sdk.coders

Class CustomCoder<T>

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.CustomCoder<T>

Type Parameters:

T - the type of elements handled by this coder

All Implemented Interfaces:

Coder<T>, Serializable

Direct Known Subclasses:

DelegateCoder

public abstract class CustomCoder<T>
extends AtomicCoder<T>
implements Serializable

An abstract base class for writing Coders that encodes itself via java serialization.

To complete an implementation, subclasses must implement Coder.encode(T, java.io.OutputStream, com.google.cloud.dataflow.sdk.coders.Coder.Context) and Coder.decode(java.io.InputStream, com.google.cloud.dataflow.sdk.coders.Coder.Context) methods. Anonymous subclasses must furthermore override getEncodingId().

Not to be confused with SerializableCoder that encodes objects that implement the Serializable interface.

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

Constructor and Description
CustomCoder()

Method Summary

Modifier and Type	Method and Description
com.google.cloud.dataflow.sdk.util.CloudObject	asCloudObject() Returns the CloudObject that represents this Coder.
String	getEncodingId() A unique identifier for the binary format written by Coder.encode(T, java.io.OutputStream, com.google.cloud.dataflow.sdk.coders.Coder.Context).
static CustomCoder<?>	of(String typeId, String encodingId, String type, String serializedCoder)
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, equals, getAllowedEncodings, getComponents, getEncodedElementByteSize, hashCode, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, toString, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.cloud.dataflow.sdk.coders.Coder

decode, encode

Constructor Detail

CustomCoder

public CustomCoder()

Method Detail

of

public static CustomCoder<?> of(String typeId,
                                String encodingId,
                                String type,
                                String serializedCoder)

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>

Overrides:

asCloudObject in class StandardCoder<T>

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>

Overrides:

verifyDeterministic in class DeterministicStandardCoder<T>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.

getEncodingId

public String getEncodingId()

Description copied from class: StandardCoder

A unique identifier for the binary format written by Coder.encode(T, java.io.OutputStream, com.google.cloud.dataflow.sdk.coders.Coder.Context). If a subclass is modified to write a new format, it is imperative that this method be overridden to return a distinct value.

By default, this is an empty string so only the fully qualified name of the class is used.

Specified by:

getEncodingId in interface Coder<T>

Overrides:

getEncodingId in class StandardCoder<T>

See Also:

StandardCoder.getAllowedEncodings()