com.google.cloud.dataflow.sdk.coders

Class VoidCoder

java.lang.Object

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

com.google.cloud.dataflow.sdk.coders.AtomicCoder<java.lang.Void>

com.google.cloud.dataflow.sdk.coders.VoidCoder

All Implemented Interfaces:

Coder<java.lang.Void>, java.io.Serializable

public class VoidCoder
extends AtomicCoder<java.lang.Void>

A VoidCoder encodes Voids. Uses zero bytes per Void.

See Also:

Serialized Form

Nested Class Summary

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

Coder.Context

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Void	decode(java.io.InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(java.lang.Void value, java.io.OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
protected long	getEncodedElementByteSize(java.lang.Void value, Coder.Context context) Returns the size in bytes of the encoded value using this coder.
boolean	isDeterministic() Returns true if the coding is deterministic.
boolean	isRegisterByteSizeObserverCheap(java.lang.Void value, Coder.Context context) Returns true since registerByteSizeObserver() runs in constant time.
static VoidCoder	of()

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

getCoderArguments, getInstanceComponents

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

asCloudObject, equals, getComponents, hashCode, registerByteSizeObserver, toString

Methods inherited from class java.lang.Object

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

Method Detail

of

public static VoidCoder of()

encode

public void encode(java.lang.Void value,
          java.io.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 java.lang.Void decode(java.io.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.

isDeterministic

public boolean isDeterministic()

Description copied from interface: Coder

Returns true if the coding is deterministic.

In order for a Coder to be considered deterministic, the following must be true:

• two values which 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.

isRegisterByteSizeObserverCheap

public boolean isRegisterByteSizeObserverCheap(java.lang.Void value,
                                      Coder.Context context)

Returns true since registerByteSizeObserver() runs in constant time.

Specified by:

isRegisterByteSizeObserverCheap in interface Coder<java.lang.Void>

Overrides:

isRegisterByteSizeObserverCheap in class StandardCoder<java.lang.Void>

getEncodedElementByteSize

protected long getEncodedElementByteSize(java.lang.Void value,
                             Coder.Context context)
                                  throws java.lang.Exception

Description copied from class: StandardCoder

Returns the size in bytes of the encoded value using this coder. Derived classes override this method if byte size can be computed with less computation or copying.

Overrides:

getEncodedElementByteSize in class StandardCoder<java.lang.Void>

Throws:

java.lang.Exception