public class BigIntegerCoder extends AtomicCoder<java.math.BigInteger>
BigIntegerCoder
encodes a BigInteger
as a byte array containing the big endian
two's-complement representation, encoded via ByteArrayCoder
.Coder.Context, Coder.NonDeterministicException
Modifier and Type | Method and Description |
---|---|
boolean |
consistentWithEquals()
|
java.math.BigInteger |
decode(java.io.InputStream inStream)
Decodes a value of type
T from the given input stream in the given context. |
java.math.BigInteger |
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.math.BigInteger value,
java.io.OutputStream outStream)
Encodes the given value of type
T onto the given output stream. |
void |
encode(java.math.BigInteger 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.math.BigInteger value)
Returns the size in bytes of the encoded value using this coder.
|
boolean |
isRegisterByteSizeObserverCheap(java.math.BigInteger value)
Returns whether
Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver) 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 BigIntegerCoder |
of() |
void |
verifyDeterministic()
Throw
Coder.NonDeterministicException if the coding is not deterministic. |
equals, getCoderArguments, getComponents, hashCode
toString
getEncodedTypeDescriptor, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic
public static BigIntegerCoder of()
public void encode(java.math.BigInteger value, java.io.OutputStream outStream) throws java.io.IOException, CoderException
Coder
T
onto the given output stream.encode
in class Coder<java.math.BigInteger>
java.io.IOException
- if writing to the OutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reasonpublic void encode(java.math.BigInteger value, java.io.OutputStream outStream, Coder.Context context) throws java.io.IOException, CoderException
Coder
T
onto the given output stream in the given context.encode
in class Coder<java.math.BigInteger>
java.io.IOException
- if writing to the OutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reasonpublic java.math.BigInteger decode(java.io.InputStream inStream) throws java.io.IOException, CoderException
Coder
T
from the given input stream in the given context. Returns the
decoded value.decode
in class Coder<java.math.BigInteger>
java.io.IOException
- if reading from the InputStream
fails for some reasonCoderException
- if the value could not be decoded for some reasonpublic java.math.BigInteger decode(java.io.InputStream inStream, Coder.Context context) throws java.io.IOException, CoderException
Coder
T
from the given input stream in the given context. Returns the
decoded value.decode
in class Coder<java.math.BigInteger>
java.io.IOException
- if reading from the InputStream
fails for some reasonCoderException
- if the value could not be decoded for some reasonpublic void verifyDeterministic()
AtomicCoder
Coder.NonDeterministicException
if the coding is not deterministic.
In order for a Coder
to be considered deterministic, the following must be true:
Object.equals()
or Comparable.compareTo()
, if supported) have the same encoding.
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
verifyDeterministic
in class AtomicCoder<java.math.BigInteger>
public boolean consistentWithEquals()
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.
By default, returns false.
consistentWithEquals
in class Coder<java.math.BigInteger>
true
. This coder is injective.public boolean isRegisterByteSizeObserverCheap(java.math.BigInteger value)
Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)
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.
By default, returns false. The default Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)
implementation
invokes Coder.getEncodedElementByteSize(T)
which requires re-encoding an element unless it is
overridden. This is considered expensive.
isRegisterByteSizeObserverCheap
in class Coder<java.math.BigInteger>
true
, because getEncodedElementByteSize(java.math.BigInteger)
runs in constant time.protected long getEncodedElementByteSize(java.math.BigInteger value) throws java.lang.Exception
getEncodedElementByteSize
in class Coder<java.math.BigInteger>
ByteArrayCoder
java.lang.Exception