com.google.cloud.dataflow.sdk.coders

Class DelegateCoder<T,DT>

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

com.google.cloud.dataflow.sdk.coders.DelegateCoder<T,DT>

Type Parameters:

T - The type of objects coded by this Coder.

DT - The type of objects a T will be converted to for coding.

All Implemented Interfaces:

Coder<T>, java.io.Serializable

Direct Known Subclasses:

StringDelegateCoder

public class DelegateCoder<T,DT>
extends CustomCoder<T>

A DelegateCoder<T, DT> wraps a Coder<DT> and encodes/decodes values of type Ts by converting to/from DT and then encoding/decoding using the underlying Coder<DT>.

The conversions from T to DT and vice versa must be supplied as DelegateCoder.CodingFunction, a serializable function that may throw any Exception. If a thrown exception is an instance of CoderException or IOException, it will be re-thrown, otherwise it will be wrapped as a CoderException.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DelegateCoder.CodingFunction<Input,Output> A CodingFunction<Input, Output> is a serializable function from Input to Output that may throw any Exception.

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	DelegateCoder(Coder<DT> coder, DelegateCoder.CodingFunction<T,DT> toFn, DelegateCoder.CodingFunction<DT,T> fromFn)

Method Summary

Methods

Modifier and Type	Method and Description
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	isDeterministic() Deprecated.
static <T,DT> DelegateCoder<T,DT>	of(Coder<DT> coder, DelegateCoder.CodingFunction<T,DT> toFn, DelegateCoder.CodingFunction<DT,T> fromFn)
java.lang.Object	structuralValue(T value) Returns an object with an Object.equals() method that represents structural equality on the argument.
java.lang.String	toString()
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.

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

asCloudObject, of

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, getComponents, getEncodedElementByteSize, hashCode, isRegisterByteSizeObserverCheap, registerByteSizeObserver, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegateCoder

protected DelegateCoder(Coder<DT> coder,
             DelegateCoder.CodingFunction<T,DT> toFn,
             DelegateCoder.CodingFunction<DT,T> fromFn)

Method Detail

of

public static <T,DT> DelegateCoder<T,DT> of(Coder<DT> coder,
                            DelegateCoder.CodingFunction<T,DT> toFn,
                            DelegateCoder.CodingFunction<DT,T> fromFn)

encode

public void encode(T 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 T 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.

Specified by:

isDeterministic in interface Coder<T>

Overrides:

isDeterministic in class CustomCoder<T>

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

Overrides:

verifyDeterministic in class StandardCoder<T>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.

structuralValue

public java.lang.Object structuralValue(T value)
                                 throws java.lang.Exception

Description copied from interface: Coder

Returns an object with an Object.equals() method that represents structural equality on the argument. (and also implements a compatible Object.hashCode()).

For any two objects of type T, if their encoded bytes are the same, then their structural values are equal according to Object.equals().

Most notably, the structural value for an array coder should perform a structural comparison of the contents of the arrays, rather than the default behavior of comparing according to object identity.

See also Coder.consistentWithEquals().

Specified by:

structuralValue in interface Coder<T>

Overrides:

structuralValue in class StandardCoder<T>

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class StandardCoder<T>