org.apache.beam.sdk.coders

Class CustomCoder<T>

java.lang.Object

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

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

Type Parameters:

T - the type of values being encoded and decoded

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AmqpMessageCoder, AvroCoder, CoGbkResult.CoGbkResultCoder, DelegateCoder, JAXBCoder, ProtoCoder, PubsubMessagePayloadOnlyCoder, PubsubMessageWithAttributesCoder, SerializableCoder, StringDelegateCoder, WritableCoder

public abstract class CustomCoder<T>
extends Coder<T>
implements java.io.Serializable

An abstract base class that implements all methods of Coder except Coder.encode(T, java.io.OutputStream) and Coder.decode(java.io.InputStream).

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

Constructor and Description
CustomCoder()

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends Coder<?>>	getCoderArguments() If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters in the same order they appear within the parameterized type's type signature.
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomCoder

public CustomCoder()

Method Detail

getCoderArguments

public java.util.List<? extends Coder<?>> getCoderArguments()

If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters in the same order they appear within the parameterized type's type signature. If this cannot be done, or this Coder does not encode/decode a parameterized type, returns the empty list..

Returns an empty list. A CustomCoder has no default argument coders.

Specified by:

getCoderArguments in class Coder<T>

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.

Specified by:

verifyDeterministic in class Coder<T>

Throws:

NonDeterministicException - a CustomCoder is presumed nondeterministic.

Coder.NonDeterministicException - if this coder is not deterministic.