Package org.apache.beam.sdk.coders

Class StructuredCoder<T>

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AtomicCoder, FailsafeValueInSingleWindow.Coder, FileBasedSink.FileResultCoder, GlobalWindow.Coder, IntervalWindow.IntervalWindowCoder, IsmFormat.MetadataKeyCoder, IterableLikeCoder, KafkaRecordCoder, KvCoder, LengthPrefixCoder, MapCoder, NullableCoder, OptionalCoder, PCollectionViews.ValueOrMetadataCoder, ProducerRecordCoder, ReadableFileCoder, ShardedKeyCoder, SingletonKeyedWorkItemCoder, SnappyCoder, SortedMapCoder, TestStream.TestStreamCoder, TimestampedValue.TimestampedValueCoder, TimestampPrefixingWindowCoder, TopicPartitionCoder, UnionCoder, ValueInSingleWindow.Coder, ValueWithRecordId.ValueWithRecordIdCoder, VarLongCoder, WindowedValues.WindowedValueCoder

public abstract class StructuredCoder<T>
extends Coder<T>

An abstract base class to implement a Coder that defines equality, hashing, and printing via the class name and recursively using getComponents().

A StructuredCoder should be defined purely in terms of its component coders, and contain no additional configuration.

To extend StructuredCoder, override the following methods as appropriate:

• getComponents(): the default implementation returns Coder.getCoderArguments().
• Coder.getEncodedElementByteSize(T) and Coder.isRegisterByteSizeObserverCheap(T): the default implementation encodes values to bytes and counts the bytes, which is considered expensive. The default element byte size observer uses the value returned by Coder.getEncodedElementByteSize(T).

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	Description
protected	StructuredCoder()

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
List<? extends Coder<?>>	getComponents()	Returns the list of Coders that are components of this Coder.
int	hashCode()
String	toString()

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

consistentWithEquals, decode, decode, encode, encode, getCoderArguments, getEncodedElementByteSize, getEncodedElementByteSizeUsingCoder, getEncodedTypeDescriptor, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Constructor Details

StructuredCoder

protected StructuredCoder()

Method Details

getComponents

public List<? extends Coder<?>> getComponents()

Returns the list of Coders that are components of this Coder.

The default components will be equal to the value returned by Coder.getCoderArguments().

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

Returns:

true if the two StructuredCoder instances have the same class and equal components.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object