public class BooleanCoder extends AtomicCoder<java.lang.Boolean>
Coder
for Boolean
.Coder.Context, Coder.NonDeterministicException
Constructor and Description |
---|
BooleanCoder() |
Modifier and Type | Method and Description |
---|---|
boolean |
consistentWithEquals()
|
java.lang.Boolean |
decode(java.io.InputStream is)
Decodes a value of type
T from the given input stream in the given context. |
void |
encode(java.lang.Boolean value,
java.io.OutputStream os)
Encodes the given value of type
T onto the given output stream. |
protected long |
getEncodedElementByteSize(java.lang.Boolean value)
Returns the size in bytes of the encoded value using this coder.
|
boolean |
isRegisterByteSizeObserverCheap(java.lang.Boolean 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 BooleanCoder |
of()
Returns the singleton instance of
BooleanCoder . |
equals, getCoderArguments, getComponents, hashCode, verifyDeterministic
toString
decode, encode, getEncodedTypeDescriptor, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic
public static BooleanCoder of()
BooleanCoder
.public void encode(java.lang.Boolean value, java.io.OutputStream os) throws java.io.IOException
Coder
T
onto the given output stream.encode
in class Coder<java.lang.Boolean>
java.io.IOException
- if writing to the OutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reasonpublic java.lang.Boolean decode(java.io.InputStream is) throws java.io.IOException
Coder
T
from the given input stream in the given context. Returns the
decoded value.decode
in class Coder<java.lang.Boolean>
java.io.IOException
- if reading from the InputStream
fails for some reasonCoderException
- if the value could not be decoded for some reasonpublic boolean consistentWithEquals()
Coder
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.lang.Boolean>
public boolean isRegisterByteSizeObserverCheap(java.lang.Boolean value)
Coder
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.lang.Boolean>
protected long getEncodedElementByteSize(java.lang.Boolean value) throws java.lang.Exception
Coder
getEncodedElementByteSize
in class Coder<java.lang.Boolean>
java.lang.Exception