org.apache.beam.sdk.coders

Class BigDecimalCoder

java.lang.Object

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

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

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

org.apache.beam.sdk.coders.BigDecimalCoder

All Implemented Interfaces:

Serializable, Coder<BigDecimal>

public class BigDecimalCoder
extends AtomicCoder<BigDecimal>

A BigDecimalCoder encodes a BigDecimal as an integer scale encoded with VarIntCoder and a BigInteger encoded using BigIntegerCoder. The BigInteger, when scaled (with unlimited precision, aka MathContext.UNLIMITED), yields the expected BigDecimal.

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).
BigDecimal	decode(InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(BigDecimal 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(BigDecimal value, Coder.Context context) Returns the size in bytes of the encoded value using this coder.
boolean	isRegisterByteSizeObserverCheap(BigDecimal 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 BigDecimalCoder	of()

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

getCoderArguments, getInstanceComponents

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

verifyDeterministic

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 BigDecimalCoder of()

encode

public void encode(BigDecimal 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 BigDecimal 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

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

Overrides:

consistentWithEquals in class StandardCoder<BigDecimal>

Returns:

true. This coder is injective.

isRegisterByteSizeObserverCheap

public boolean isRegisterByteSizeObserverCheap(BigDecimal 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<BigDecimal>

Overrides:

isRegisterByteSizeObserverCheap in class StandardCoder<BigDecimal>

Returns:

true, because getEncodedElementByteSize(java.math.BigDecimal, org.apache.beam.sdk.coders.Coder.Context) runs in constant time.

getEncodedElementByteSize

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

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

Overrides:

getEncodedElementByteSize in class StandardCoder<BigDecimal>

Returns:

4 (the size of an integer denoting the scale) plus 4 (the size of an integer length prefix for the following bytes) plus the size of the two's-complement representation of the BigInteger that, when scaled, equals the given value.

Throws:

Exception