Google Cloud Dataflow SDK for Java, version 1.9.1
Class VarLongCoder
- java.lang.Object
-
- com.google.cloud.dataflow.sdk.coders.StandardCoder<T>
-
- com.google.cloud.dataflow.sdk.coders.DeterministicStandardCoder<T>
-
- com.google.cloud.dataflow.sdk.coders.AtomicCoder<Long>
-
- com.google.cloud.dataflow.sdk.coders.VarLongCoder
-
- All Implemented Interfaces:
- Coder<Long>, Serializable
public class VarLongCoder extends AtomicCoder<Long>
ACoder
that encodesLongs
using between 1 and 10 bytes. Negative numbers always take 10 bytes, soBigEndianLongCoder
may be preferable for longs that are known to often be large or negative.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.google.cloud.dataflow.sdk.coders.Coder
Coder.Context, Coder.NonDeterministicException
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description boolean
consistentWithEquals()
Long
decode(InputStream inStream, Coder.Context context)
Decodes a value of typeT
from the given input stream in the given context.void
encode(Long value, OutputStream outStream, Coder.Context context)
Encodes the given value of typeT
onto the given output stream in the given context.protected long
getEncodedElementByteSize(Long value, Coder.Context context)
Returns the size in bytes of the encoded value using this coder.boolean
isRegisterByteSizeObserverCheap(Long value, Coder.Context context)
Returns whetherCoder.registerByteSizeObserver(T, com.google.cloud.dataflow.sdk.util.common.ElementByteSizeObserver, com.google.cloud.dataflow.sdk.coders.Coder.Context)
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 VarLongCoder
of()
-
Methods inherited from class com.google.cloud.dataflow.sdk.coders.AtomicCoder
getCoderArguments, getInstanceComponents
-
Methods inherited from class com.google.cloud.dataflow.sdk.coders.DeterministicStandardCoder
verifyDeterministic
-
Methods inherited from class com.google.cloud.dataflow.sdk.coders.StandardCoder
asCloudObject, equals, getAllowedEncodings, getComponents, getEncodingId, hashCode, registerByteSizeObserver, structuralValue, toString, verifyDeterministic, verifyDeterministic
-
-
-
-
Method Detail
-
of
public static VarLongCoder of()
-
encode
public void encode(Long value, OutputStream outStream, Coder.Context context) throws IOException, CoderException
Description copied from interface:Coder
Encodes the given value of typeT
onto the given output stream in the given context.- Throws:
IOException
- if writing to theOutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reason
-
decode
public Long decode(InputStream inStream, Coder.Context context) throws IOException, CoderException
Description copied from interface:Coder
Decodes a value of typeT
from the given input stream in the given context. Returns the decoded value.- Throws:
IOException
- if reading from theInputStream
fails for some reasonCoderException
- if the value could not be decoded for some reason
-
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.- Specified by:
consistentWithEquals
in interfaceCoder<Long>
- Overrides:
consistentWithEquals
in classStandardCoder<Long>
- Returns:
true
.VarLongCoder
is injective.
-
isRegisterByteSizeObserverCheap
public boolean isRegisterByteSizeObserverCheap(Long value, Coder.Context context)
Returns whetherCoder.registerByteSizeObserver(T, com.google.cloud.dataflow.sdk.util.common.ElementByteSizeObserver, com.google.cloud.dataflow.sdk.coders.Coder.Context)
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.- Specified by:
isRegisterByteSizeObserverCheap
in interfaceCoder<Long>
- Overrides:
isRegisterByteSizeObserverCheap
in classStandardCoder<Long>
- Returns:
true
.getEncodedElementByteSize(java.lang.Long, com.google.cloud.dataflow.sdk.coders.Coder.Context)
is cheap.
-
getEncodedElementByteSize
protected long getEncodedElementByteSize(Long value, Coder.Context context) throws Exception
Description copied from class:StandardCoder
Returns the size in bytes of the encoded value using this coder.- Overrides:
getEncodedElementByteSize
in classStandardCoder<Long>
- Throws:
Exception
-
-