public class InstantCoder extends AtomicCoder<Instant>
Coder for joda Instant that encodes it as a big endian Long shifted
such that lexicographic ordering of the bytes corresponds to chronological order.Coder.Context, Coder.NonDeterministicException| Modifier and Type | Method and Description |
|---|---|
boolean |
consistentWithEquals()
|
Instant |
decode(java.io.InputStream inStream)
Decodes a value of type
T from the given input stream in the given context. |
void |
encode(Instant value,
java.io.OutputStream outStream)
Encodes the given value of type
T onto the given output stream. |
protected long |
getEncodedElementByteSize(Instant value)
Returns the size in bytes of the encoded value using this coder.
|
TypeDescriptor<Instant> |
getEncodedTypeDescriptor()
Returns the
TypeDescriptor for the type encoded. |
boolean |
isRegisterByteSizeObserverCheap(Instant 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 InstantCoder |
of() |
void |
verifyDeterministic()
Throw
Coder.NonDeterministicException if the coding is not deterministic. |
equals, getCoderArguments, getComponents, hashCodetoStringdecode, encode, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministicpublic static InstantCoder of()
public void encode(Instant value, java.io.OutputStream outStream) throws CoderException, java.io.IOException
CoderT 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<Instant>CoderException - if the value could not be encoded for some reasonjava.io.IOException - if writing to the OutputStream fails for some reasonpublic Instant decode(java.io.InputStream inStream) throws CoderException, java.io.IOException
CoderT 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<Instant>CoderException - if the value could not be decoded for some reasonjava.io.IOException - if reading from the InputStream fails for some reasonpublic void verifyDeterministic()
AtomicCoderCoder.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<Instant>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<Instant>true. This coder is injective.public boolean isRegisterByteSizeObserverCheap(Instant 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<Instant>true. The byte size for a big endian long is a constant.protected long getEncodedElementByteSize(Instant value) throws java.lang.Exception
CodergetEncodedElementByteSize in class Coder<Instant>java.lang.Exceptionpublic TypeDescriptor<Instant> getEncodedTypeDescriptor()
CoderTypeDescriptor for the type encoded.getEncodedTypeDescriptor in class Coder<Instant>