com.google.cloud.dataflow.sdk.util

Class TimerOrElement.TimerOrElementCoder<T>

java.lang.Object

com.google.cloud.dataflow.sdk.coders.StandardCoder<TimerOrElement<T>>

com.google.cloud.dataflow.sdk.util.TimerOrElement.TimerOrElementCoder<T>

All Implemented Interfaces:

Coder<TimerOrElement<T>>, Serializable

Enclosing class:

TimerOrElement<ElemT>

public static class TimerOrElement.TimerOrElementCoder<T>
extends StandardCoder<TimerOrElement<T>>

Coder that forwards ByteSizeObserver calls to an underlying element coder. TimerOrElement objects never need to be encoded, so this class does not support the encode and decode methods.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.cloud.dataflow.sdk.coders.Coder

Coder.Context, Coder.NonDeterministicException

Method Summary

Modifier and Type	Method and Description
TimerOrElement<T>	decode(InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(TimerOrElement<T> value, OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
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, or returns null if this cannot be done or this is not a parameterized type.
Coder<T>	getElementCoder()
boolean	isRegisterByteSizeObserverCheap(TimerOrElement<T> value, Coder.Context context) StandardCoder requires elements to be fully encoded and copied into a byte stream to determine the byte size of the element, which is considered expensive.
static <T> TimerOrElement.TimerOrElementCoder<T>	of(Coder<T> elemCoder) Creates a new TimerOrElement.Coder that wraps the given Coder.
static TimerOrElement.TimerOrElementCoder<?>	of(List<Object> components)
void	registerByteSizeObserver(TimerOrElement<T> value, ElementByteSizeObserver observer, Coder.Context context) Notifies ElementByteSizeObserver about the byte size of the encoded value using this coder.
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.

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

asCloudObject, consistentWithEquals, equals, getAllowedEncodings, getComponents, getEncodedElementByteSize, getEncodingId, hashCode, structuralValue, toString, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <T> TimerOrElement.TimerOrElementCoder<T> of(Coder<T> elemCoder)

Creates a new TimerOrElement.Coder that wraps the given Coder.

of

public static TimerOrElement.TimerOrElementCoder<?> of(List<Object> components)

encode

public void encode(TimerOrElement<T> value,
                   OutputStream outStream,
                   Coder.Context context)

Description copied from interface: Coder

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

decode

public TimerOrElement<T> decode(InputStream inStream,
                                Coder.Context context)

Description copied from interface: Coder

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

isRegisterByteSizeObserverCheap

public boolean isRegisterByteSizeObserverCheap(TimerOrElement<T> value,
                                               Coder.Context context)

Description copied from class: StandardCoder

StandardCoder requires elements to be fully encoded and copied into a byte stream to determine the byte size of the element, which is considered expensive.

Specified by:

isRegisterByteSizeObserverCheap in interface Coder<TimerOrElement<T>>

Overrides:

isRegisterByteSizeObserverCheap in class StandardCoder<TimerOrElement<T>>

registerByteSizeObserver

public void registerByteSizeObserver(TimerOrElement<T> value,
                                     ElementByteSizeObserver observer,
                                     Coder.Context context)
                              throws Exception

Description copied from class: StandardCoder

Notifies ElementByteSizeObserver about the byte size of the encoded value using this coder. Calls getEncodedElementByteSize() and notifies ElementByteSizeObserver.

Specified by:

registerByteSizeObserver in interface Coder<TimerOrElement<T>>

Overrides:

registerByteSizeObserver in class StandardCoder<TimerOrElement<T>>

Throws:

Exception

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.

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.

getCoderArguments

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

Description copied from interface: Coder

If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters, or returns null if this cannot be done or this is not a parameterized type.

getElementCoder

public Coder<T> getElementCoder()