org.apache.beam.sdk.coders

Class DoubleCoder

java.lang.Object

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

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

org.apache.beam.sdk.coders.AtomicCoder<Double>

org.apache.beam.sdk.coders.DoubleCoder

All Implemented Interfaces:

Serializable, Coder<Double>

public class DoubleCoder
extends AtomicCoder<Double>

A DoubleCoder encodes Double values in 8 bytes using Java serialization.

See Also:

Serialized Form

Nested Class Summary

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

Coder.Context, Coder.NonDeterministicException

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).
Double	decode(InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(Double value, OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
protected long	getEncodedElementByteSize(Double value, Coder.Context context) Returns the size in bytes of the encoded value using this coder.
boolean	isRegisterByteSizeObserverCheap(Double value, Coder.Context context) Returns whether Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver, org.apache.beam.sdk.coders.Coder.Context) cheap enough to call for every element, that is, if this Coder can calculate the byte size of the element to be coded in roughly constant time (or lazily).
static DoubleCoder	of()
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.

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

getCoderArguments, getInstanceComponents

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

asCloudObject, equals, getAllowedEncodings, getComponents, getEncodingId, hashCode, registerByteSizeObserver, structuralValue, toString, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Method Detail

of

public static DoubleCoder of()

encode

public void encode(Double value,
                   OutputStream outStream,
                   Coder.Context context)
            throws IOException,
                   CoderException

Description copied from interface: Coder

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

Throws:

IOException - if writing to the OutputStream fails for some reason

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

decode

public Double decode(InputStream inStream,
                     Coder.Context context)
              throws 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:

IOException - if reading from the InputStream fails for some reason

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

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 interface Coder<Double>

Overrides:

verifyDeterministic in class DeterministicStandardCoder<Double>

Throws:

NonDeterministicException - always. Floating-point operations are not guaranteed to be deterministic, even if the storage format might be, so floating point representations are not recommended for use in operations that require deterministic inputs.

Coder.NonDeterministicException - if this coder is not deterministic.

consistentWithEquals

public boolean consistentWithEquals()

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.

Specified by:

consistentWithEquals in interface Coder<Double>

Overrides:

consistentWithEquals in class StandardCoder<Double>

Returns:

true. This coder is injective.

isRegisterByteSizeObserverCheap

public boolean isRegisterByteSizeObserverCheap(Double value,
                                               Coder.Context context)

Returns whether Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver, org.apache.beam.sdk.coders.Coder.Context) cheap enough to call for every element, that is, if this Coder can calculate the byte size of the element to be coded in roughly constant time (or lazily).

Not intended to be called by user code, but instead by PipelineRunner implementations.

Specified by:

isRegisterByteSizeObserverCheap in interface Coder<Double>

Overrides:

isRegisterByteSizeObserverCheap in class StandardCoder<Double>

Returns:

true. getEncodedElementByteSize(java.lang.Double, org.apache.beam.sdk.coders.Coder.Context) returns a constant.

getEncodedElementByteSize

protected long getEncodedElementByteSize(Double value,
                                         Coder.Context context)
                                  throws Exception

Returns the size in bytes of the encoded value using this coder.

Overrides:

getEncodedElementByteSize in class StandardCoder<Double>

Returns:

8, the byte size of a Double encoded using Java serialization.

Throws:

Exception