com.google.cloud.dataflow.sdk.coders

Class VarLongCoder

java.lang.Object

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

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

com.google.cloud.dataflow.sdk.coders.VarLongCoder

All Implemented Interfaces:

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

public class VarLongCoder
extends AtomicCoder<java.lang.Long>

A VarLongCoder encodes longs using between 1 and 10 bytes. Negative numbers always take 10 bytes, so BigEndianLongCoder may be preferable for longs that are known to often be large or negative.

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

Methods

Modifier and Type	Method and Description
java.lang.Long	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.Long 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.Long value, Coder.Context context) Returns the size in bytes of the encoded value using this coder.
boolean	isDeterministic() Deprecated.
boolean	isRegisterByteSizeObserverCheap(java.lang.Long value, Coder.Context context) Returns true since registerByteSizeObserver() runs in constant time.
static VarLongCoder	of()
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.

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, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Method Detail

of

public static VarLongCoder of()

encode

public void encode(java.lang.Long value,
          java.io.OutputStream outStream,
          Coder.Context context)
            throws java.io.IOException,
                   CoderException

Description copied from interface: Coder

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

Throws:

java.io.IOException - if writing to the OutputStream fails for some reason

CoderException - if the value could not be encoded for some reason

decode

public java.lang.Long decode(java.io.InputStream inStream,
                    Coder.Context context)
                      throws java.io.IOException,
                             CoderException

Description copied from interface: Coder

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

Throws:

java.io.IOException - if reading from the InputStream fails for some reason

CoderException - if the value could not be decoded for some reason

isDeterministic

@Deprecated
public boolean isDeterministic()

Deprecated.

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.

verifyDeterministic

public void verifyDeterministic()

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

Specified by:

verifyDeterministic in interface Coder<java.lang.Long>

Overrides:

verifyDeterministic in class StandardCoder<java.lang.Long>

isRegisterByteSizeObserverCheap

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

Returns true since registerByteSizeObserver() runs in constant time.

Specified by:

isRegisterByteSizeObserverCheap in interface Coder<java.lang.Long>

Overrides:

isRegisterByteSizeObserverCheap in class StandardCoder<java.lang.Long>

getEncodedElementByteSize

protected long getEncodedElementByteSize(java.lang.Long 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.Long>

Throws:

java.lang.Exception