org.apache.beam.sdk.coders

Class IterableCoder<T>

java.lang.Object

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

org.apache.beam.sdk.coders.StructuredCoder<IterableT>

org.apache.beam.sdk.coders.IterableLikeCoder<T,java.lang.Iterable<T>>

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

Type Parameters:

T - the type of the elements of the iterables being transcoded

All Implemented Interfaces:

java.io.Serializable

public class IterableCoder<T>
extends IterableLikeCoder<T,java.lang.Iterable<T>>

An IterableCoder encodes any Iterable in the format of IterableLikeCoder.

See Also:

Serialized Form

Nested Class Summary

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

Coder.Context, Coder.NonDeterministicException

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IterableCoder(Coder<T> elemCoder)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Iterable<T>	decodeToIterable(java.util.List<T> decodedElements) Builds an instance of IterableT, this coder's associated Iterable-like subtype, from a list of decoded elements.
TypeDescriptor<java.lang.Iterable<T>>	getEncodedTypeDescriptor() Returns the TypeDescriptor for the type encoded.
static <T> IterableCoder<T>	of(Coder<T> elemCoder)
java.lang.Object	structuralValue(java.lang.Iterable<T> value) Returns an object with an Object.equals() method that represents structural equality on the argument.

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

decode, decodeToIterable, encode, getCoderArguments, getElemCoder, isRegisterByteSizeObserverCheap, registerByteSizeObserver, verifyDeterministic

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

equals, getComponents, hashCode, toString

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

consistentWithEquals, decode, encode, getEncodedElementByteSize, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Constructor Detail

IterableCoder

protected IterableCoder(Coder<T> elemCoder)

Method Detail

of

public static <T> IterableCoder<T> of(Coder<T> elemCoder)

structuralValue

public java.lang.Object structuralValue(java.lang.Iterable<T> value)

Description copied from class: Coder

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(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<java.lang.Iterable<T>>

decodeToIterable

protected final java.lang.Iterable<T> decodeToIterable(java.util.List<T> decodedElements)

Description copied from class: IterableLikeCoder

Builds an instance of IterableT, this coder's associated Iterable-like subtype, from a list of decoded elements.

Override IterableLikeCoder.decodeToIterable(List, long, InputStream) if you need access to the terminator value and the InputStream.

Specified by:

decodeToIterable in class IterableLikeCoder<T,java.lang.Iterable<T>>

getEncodedTypeDescriptor

public TypeDescriptor<java.lang.Iterable<T>> getEncodedTypeDescriptor()

Description copied from class: Coder

Returns the TypeDescriptor for the type encoded.

Overrides:

getEncodedTypeDescriptor in class Coder<java.lang.Iterable<T>>