Class OffsetRange.Coder
- java.lang.Object
-
- org.apache.beam.sdk.coders.Coder<T>
-
- org.apache.beam.sdk.coders.StructuredCoder<T>
-
- org.apache.beam.sdk.coders.AtomicCoder<OffsetRange>
-
- org.apache.beam.sdk.io.range.OffsetRange.Coder
-
- All Implemented Interfaces:
java.io.Serializable
- Enclosing class:
- OffsetRange
public static class OffsetRange.Coder extends AtomicCoder<OffsetRange>
A coder forOffsetRange
s.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.beam.sdk.coders.Coder
Coder.Context, Coder.NonDeterministicException
-
-
Constructor Summary
Constructors Constructor Description Coder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
consistentWithEquals()
OffsetRange
decode(java.io.InputStream inStream)
Decodes a value of typeT
from the given input stream in the given context.void
encode(OffsetRange value, java.io.OutputStream outStream)
Encodes the given value of typeT
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 theTypeDescriptor
for the type encoded.boolean
isRegisterByteSizeObserverCheap(OffsetRange 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 OffsetRange.Coder
of()
-
Methods inherited from class org.apache.beam.sdk.coders.AtomicCoder
equals, getCoderArguments, getComponents, hashCode, verifyDeterministic
-
Methods inherited from class org.apache.beam.sdk.coders.StructuredCoder
toString
-
Methods inherited from class org.apache.beam.sdk.coders.Coder
decode, encode, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic
-
-
-
-
Method Detail
-
of
public static OffsetRange.Coder of()
-
encode
public void encode(OffsetRange value, java.io.OutputStream outStream) throws CoderException, java.io.IOException
Description copied from class:Coder
Encodes the given value of typeT
onto the given output stream.- Specified by:
encode
in classCoder<OffsetRange>
- Throws:
CoderException
- if the value could not be encoded for some reasonjava.io.IOException
- if writing to theOutputStream
fails for some reason
-
decode
public OffsetRange decode(java.io.InputStream inStream) throws CoderException, java.io.IOException
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<OffsetRange>
- Throws:
CoderException
- if the value could not be decoded for some reasonjava.io.IOException
- if reading from theInputStream
fails for some reason
-
isRegisterByteSizeObserverCheap
public boolean isRegisterByteSizeObserverCheap(OffsetRange value)
Description copied from class:Coder
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<OffsetRange>
-
getEncodedElementByteSize
protected long getEncodedElementByteSize(OffsetRange value) throws java.lang.Exception
Description copied from class:Coder
Returns the size in bytes of the encoded value using this coder.- Overrides:
getEncodedElementByteSize
in classCoder<OffsetRange>
- Throws:
java.lang.Exception
-
consistentWithEquals
public boolean consistentWithEquals()
Description copied from class:Coder
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<OffsetRange>
-
getEncodedTypeDescriptor
public TypeDescriptor<OffsetRange> getEncodedTypeDescriptor()
Description copied from class:Coder
Returns theTypeDescriptor
for the type encoded.- Overrides:
getEncodedTypeDescriptor
in classCoder<OffsetRange>
-
-