org.apache.beam.sdk.transforms.windowing

Class GlobalWindow.Coder

java.lang.Object

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

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

org.apache.beam.sdk.transforms.windowing.GlobalWindow.Coder

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

GlobalWindow

public static class GlobalWindow.Coder
extends StructuredCoder<GlobalWindow>

GlobalWindow.Coder for encoding and decoding GlobalWindows.

See Also:

Serialized Form

Nested Class Summary

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

Coder.Context, Coder.NonDeterministicException

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalWindow.Coder	INSTANCE

Method Summary

Modifier and Type	Method and Description
boolean	consistentWithEquals() Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).
GlobalWindow	decode(java.io.InputStream inStream) Decodes a value of type T from the given input stream in the given context.
void	encode(GlobalWindow window, java.io.OutputStream outStream) Encodes the given value of type T onto the given output stream.
java.util.List<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.StructuredCoder

equals, getComponents, getEncodedTypeDescriptor, hashCode, structuralValue, toString

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

decode, encode, getEncodedElementByteSize, isRegisterByteSizeObserverCheap, registerByteSizeObserver, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final GlobalWindow.Coder INSTANCE

Method Detail

encode

public void encode(GlobalWindow window,
                   java.io.OutputStream outStream)

Description copied from class: Coder

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

Specified by:

encode in class Coder<GlobalWindow>

decode

public GlobalWindow decode(java.io.InputStream inStream)

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<GlobalWindow>

verifyDeterministic

public void verifyDeterministic()

Description copied from class: 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.

Specified by:

verifyDeterministic in class Coder<GlobalWindow>

consistentWithEquals

public boolean consistentWithEquals()

Description copied from class: StructuredCoder

Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).

Whenever the encoded bytes of two values are equal, then the original values are equal according to Objects.equals(). Note that this is well-defined for null.

This condition is most notably false for arrays. More generally, this condition is false whenever equals() compares object identity, rather than performing a semantic/structural comparison.

By default, returns false.

Overrides:

consistentWithEquals in class StructuredCoder<GlobalWindow>

Returns:

false for StructuredCoder unless overridden.

getCoderArguments

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

Description copied from class: Coder

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.

Specified by:

getCoderArguments in class Coder<GlobalWindow>