org.apache.beam.sdk.coders

Class DelegateCoder<T,IntermediateT>

java.lang.Object

org.apache.beam.sdk.coders.Coder<T>

org.apache.beam.sdk.coders.CustomCoder<T>

org.apache.beam.sdk.coders.DelegateCoder<T,IntermediateT>

Type Parameters:

T - The type of objects coded by this Coder.

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

All Implemented Interfaces:

java.io.Serializable

public final class DelegateCoder<T,IntermediateT>
extends CustomCoder<T>

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

The conversions from T to IntermediateT 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<InputT,OutputT> A CodingFunction<InputT, OutputT> is a serializable function from InputT to OutputT that may throw any Exception.

Nested classes/interfaces inherited from class org.apache.beam.sdk.coders.Coder

Coder.Context, Coder.NonDeterministicException

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DelegateCoder(Coder<IntermediateT> coder, DelegateCoder.CodingFunction<T,IntermediateT> toFn, DelegateCoder.CodingFunction<IntermediateT,T> fromFn, TypeDescriptor<T> typeDescriptor)

Method Summary

Modifier and Type	Method and Description
T	decode(java.io.InputStream inStream) Decodes a value of type T from the given input stream in the given context.
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) Encodes the given value of type T onto the given output stream.
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 o)
Coder<IntermediateT>	getCoder() Returns the coder used to encode/decode the intermediate values produced/consumed by the coding functions of this DelegateCoder.
TypeDescriptor<T>	getEncodedTypeDescriptor() Returns the TypeDescriptor for the type encoded.
int	hashCode()
static <T,IntermediateT> DelegateCoder<T,IntermediateT>	of(Coder<IntermediateT> coder, DelegateCoder.CodingFunction<T,IntermediateT> toFn, DelegateCoder.CodingFunction<IntermediateT,T> fromFn)
static <T,IntermediateT> DelegateCoder<T,IntermediateT>	of(Coder<IntermediateT> coder, DelegateCoder.CodingFunction<T,IntermediateT> toFn, DelegateCoder.CodingFunction<IntermediateT,T> fromFn, TypeDescriptor<T> typeDescriptor)
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 org.apache.beam.sdk.coders.CustomCoder

getCoderArguments

Methods inherited from class org.apache.beam.sdk.coders.Coder

consistentWithEquals, getEncodedElementByteSize, 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<IntermediateT> coder,
                        DelegateCoder.CodingFunction<T,IntermediateT> toFn,
                        DelegateCoder.CodingFunction<IntermediateT,T> fromFn,
                        @Nullable
                        TypeDescriptor<T> typeDescriptor)

Method Detail

of

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

of

public static <T,IntermediateT> DelegateCoder<T,IntermediateT> of(Coder<IntermediateT> coder,
                                                                  DelegateCoder.CodingFunction<T,IntermediateT> toFn,
                                                                  DelegateCoder.CodingFunction<IntermediateT,T> fromFn,
                                                                  @Nullable
                                                                  TypeDescriptor<T> typeDescriptor)

encode

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

Description copied from class: Coder

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

Specified by:

encode in class Coder<T>

Throws:

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

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

encode

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

Description copied from class: Coder

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

Overrides:

encode in class Coder<T>

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)
         throws CoderException,
                java.io.IOException

Description copied from class: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value.

Specified by:

decode in class Coder<T>

Throws:

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

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

decode

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

Description copied from class: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value.

Overrides:

decode in class Coder<T>

Throws:

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

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

getCoder

public Coder<IntermediateT> getCoder()

Returns the coder used to encode/decode the intermediate values produced/consumed by the coding functions of this DelegateCoder.

verifyDeterministic

public void verifyDeterministic()
                         throws Coder.NonDeterministicException

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.

Overrides:

verifyDeterministic in class CustomCoder<T>

Throws:

NonDeterministicException - when the underlying coder's verifyDeterministic() throws a Coder.NonDeterministicException. For this to be safe, the intermediate CodingFunction<T, IntermediateT> must also be deterministic.

Coder.NonDeterministicException - if this coder is not deterministic.

structuralValue

public java.lang.Object structuralValue(T value)

Returns an object with an Object.equals() method that represents structural equality on the argument.

For any two values x and y of type T, if their encoded bytes are the same, then it must be the case that structuralValue(x).equals(@code structuralValue(y).

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.
• The structural value for a coder accepting null should be a proper object with an equals() method, even if the input value is null.

See also Coder.consistentWithEquals().

By default, if this coder is Coder.consistentWithEquals(), and the value is not null, returns the provided object. Otherwise, encodes the value into a byte[], and returns an object that performs array equality on the encoded bytes.

Overrides:

structuralValue in class Coder<T>

Returns:

a structural for a value of type T obtained by first converting to IntermediateT and then obtaining a structural value according to the underlying coder.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getEncodedTypeDescriptor

public TypeDescriptor<T> getEncodedTypeDescriptor()

Description copied from class: Coder

Returns the TypeDescriptor for the type encoded.

Overrides:

getEncodedTypeDescriptor in class Coder<T>