public static class OffsetRange.Coder extends AtomicCoder<OffsetRange>
OffsetRange
s.Coder.Context, Coder.NonDeterministicException
Constructor and Description |
---|
Coder() |
Modifier and Type | Method and Description |
---|---|
boolean |
consistentWithEquals()
|
OffsetRange |
decode(java.io.InputStream inStream)
Decodes a value of type
T from the given input stream in the given context. |
void |
encode(OffsetRange value,
java.io.OutputStream outStream)
Encodes the given value of type
T onto the given output stream. |
protected long |
getEncodedElementByteSize(OffsetRange value)
Returns the size in bytes of the encoded value using this coder.
|
TypeDescriptor<OffsetRange> |
getEncodedTypeDescriptor()
Returns the
TypeDescriptor for the type encoded. |
boolean |
isRegisterByteSizeObserverCheap(OffsetRange 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 OffsetRange.Coder |
of() |
equals, getCoderArguments, getComponents, hashCode, verifyDeterministic
toString
decode, encode, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic
public static OffsetRange.Coder of()
public void encode(OffsetRange value, java.io.OutputStream outStream) throws CoderException, java.io.IOException
Coder
T
onto the given output stream. Multiple elements can
be encoded next to each other on the output stream, each coder should encode information to
know how many bytes to read when decoding. A common approach is to prefix the encoding with the
element's encoded length.encode
in class Coder<OffsetRange>
CoderException
- if the value could not be encoded for some reasonjava.io.IOException
- if writing to the OutputStream
fails for some reasonpublic OffsetRange decode(java.io.InputStream inStream) throws CoderException, java.io.IOException
Coder
T
from the given input stream in the given context. Returns the
decoded value. Multiple elements can be encoded next to each other on the input stream, each
coder should encode information to know how many bytes to read when decoding. A common approach
is to prefix the encoding with the element's encoded length.decode
in class Coder<OffsetRange>
CoderException
- if the value could not be decoded for some reasonjava.io.IOException
- if reading from the InputStream
fails for some reasonpublic boolean isRegisterByteSizeObserverCheap(OffsetRange 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<OffsetRange>
protected long getEncodedElementByteSize(OffsetRange value) throws java.lang.Exception
Coder
getEncodedElementByteSize
in class Coder<OffsetRange>
java.lang.Exception
public 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<OffsetRange>
public TypeDescriptor<OffsetRange> getEncodedTypeDescriptor()
Coder
TypeDescriptor
for the type encoded.getEncodedTypeDescriptor
in class Coder<OffsetRange>