Class BigIntegerCoder
- java.lang.Object
-
- org.apache.beam.sdk.coders.Coder<T>
-
- org.apache.beam.sdk.coders.StructuredCoder<T>
-
- org.apache.beam.sdk.coders.AtomicCoder<java.math.BigInteger>
-
- org.apache.beam.sdk.coders.BigIntegerCoder
-
- All Implemented Interfaces:
java.io.Serializable
public class BigIntegerCoder extends AtomicCoder<java.math.BigInteger>
ABigIntegerCoder
encodes aBigInteger
as a byte array containing the big endian two's-complement representation, encoded viaByteArrayCoder
.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.beam.sdk.coders.Coder
Coder.Context, Coder.NonDeterministicException
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
consistentWithEquals()
java.math.BigInteger
decode(java.io.InputStream inStream)
Decodes a value of typeT
from the given input stream in the given context.java.math.BigInteger
decode(java.io.InputStream inStream, Coder.Context context)
Decodes a value of typeT
from the given input stream in the given context.void
encode(java.math.BigInteger value, java.io.OutputStream outStream)
Encodes the given value of typeT
onto the given output stream.void
encode(java.math.BigInteger value, java.io.OutputStream outStream, Coder.Context context)
Encodes the given value of typeT
onto the given output stream in the given context.protected long
getEncodedElementByteSize(java.math.BigInteger value)
Returns the size in bytes of the encoded value using this coder.boolean
isRegisterByteSizeObserverCheap(java.math.BigInteger value)
Returns whetherCoder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)
cheap enough to call for every element, that is, if thisCoder
can calculate the byte size of the element to be coded in roughly constant time (or lazily).static BigIntegerCoder
of()
void
verifyDeterministic()
ThrowCoder.NonDeterministicException
if the coding is not deterministic.-
Methods inherited from class org.apache.beam.sdk.coders.AtomicCoder
equals, getCoderArguments, getComponents, hashCode
-
Methods inherited from class org.apache.beam.sdk.coders.StructuredCoder
toString
-
Methods inherited from class org.apache.beam.sdk.coders.Coder
getEncodedTypeDescriptor, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic
-
-
-
-
Method Detail
-
of
public static BigIntegerCoder of()
-
encode
public void encode(java.math.BigInteger value, java.io.OutputStream outStream) throws java.io.IOException, CoderException
Description copied from class:Coder
Encodes the given value of typeT
onto the given output stream.- Specified by:
encode
in classCoder<java.math.BigInteger>
- Throws:
java.io.IOException
- if writing to theOutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reason
-
encode
public void encode(java.math.BigInteger value, java.io.OutputStream outStream, Coder.Context context) throws java.io.IOException, CoderException
Description copied from class:Coder
Encodes the given value of typeT
onto the given output stream in the given context.- Overrides:
encode
in classCoder<java.math.BigInteger>
- Throws:
java.io.IOException
- if writing to theOutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reason
-
decode
public java.math.BigInteger decode(java.io.InputStream inStream) throws java.io.IOException, CoderException
Description copied from class:Coder
Decodes a value of typeT
from the given input stream in the given context. Returns the decoded value.- Specified by:
decode
in classCoder<java.math.BigInteger>
- Throws:
java.io.IOException
- if reading from theInputStream
fails for some reasonCoderException
- if the value could not be decoded for some reason
-
decode
public java.math.BigInteger decode(java.io.InputStream inStream, Coder.Context context) throws java.io.IOException, CoderException
Description copied from class:Coder
Decodes a value of typeT
from the given input stream in the given context. Returns the decoded value.- Overrides:
decode
in classCoder<java.math.BigInteger>
- Throws:
java.io.IOException
- if reading from theInputStream
fails for some reasonCoderException
- if the value could not be decoded for some reason
-
verifyDeterministic
public void verifyDeterministic()
Description copied from class:AtomicCoder
ThrowCoder.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()
orComparable.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.
Unless overridden, does not throw. An
AtomicCoder
is presumed to be deterministic- Overrides:
verifyDeterministic
in classAtomicCoder<java.math.BigInteger>
- two values that compare as equal (via
-
consistentWithEquals
public boolean consistentWithEquals()
Returnstrue
if thisCoder
is injective with respect toObject.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 fornull
.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 classCoder<java.math.BigInteger>
- Returns:
true
. This coder is injective.
-
isRegisterByteSizeObserverCheap
public boolean isRegisterByteSizeObserverCheap(java.math.BigInteger value)
Returns whetherCoder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)
cheap enough to call for every element, that is, if thisCoder
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.By default, returns false. The default
Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)
implementation invokesCoder.getEncodedElementByteSize(T)
which requires re-encoding an element unless it is overridden. This is considered expensive.- Overrides:
isRegisterByteSizeObserverCheap
in classCoder<java.math.BigInteger>
- Returns:
true
, becausegetEncodedElementByteSize(java.math.BigInteger)
runs in constant time.
-
getEncodedElementByteSize
protected long getEncodedElementByteSize(java.math.BigInteger value) throws java.lang.Exception
Returns the size in bytes of the encoded value using this coder.- Overrides:
getEncodedElementByteSize
in classCoder<java.math.BigInteger>
- Returns:
- the size of the encoding as a byte array according to
ByteArrayCoder
- Throws:
java.lang.Exception
-
-