public static class TimestampedValue.TimestampedValueCoder<T> extends StructuredCoder<TimestampedValue<T>>
Coder
for TimestampedValue
.Coder.Context, Coder.NonDeterministicException
Modifier and Type | Method and Description |
---|---|
TimestampedValue<T> |
decode(java.io.InputStream inStream)
Decodes a value of type
T from the given input stream in the given context. |
void |
encode(TimestampedValue<T> windowedElem,
java.io.OutputStream outStream)
Encodes the given value of type
T onto the given output stream. |
java.util.List<? extends Coder<?>> |
getCoderArguments()
|
java.util.List<? extends Coder<?>> |
getComponents()
|
TypeDescriptor<TimestampedValue<T>> |
getEncodedTypeDescriptor()
Returns the
TypeDescriptor for the type encoded. |
Coder<T> |
getValueCoder() |
static <T> TimestampedValue.TimestampedValueCoder<T> |
of(Coder<T> valueCoder) |
java.lang.Object |
structuralValue(TimestampedValue<T> value)
Returns an object with an
Object.equals() method that represents structural equality on
the argument. |
void |
verifyDeterministic()
Throw
Coder.NonDeterministicException if the coding is not deterministic. |
equals, hashCode, toString
consistentWithEquals, decode, encode, getEncodedElementByteSize, isRegisterByteSizeObserverCheap, registerByteSizeObserver, verifyDeterministic, verifyDeterministic
public static <T> TimestampedValue.TimestampedValueCoder<T> of(Coder<T> valueCoder)
public java.lang.Object structuralValue(TimestampedValue<T> value)
Coder
Object.equals()
method that represents structural equality on
the argument.
For any two values x
and y
of type T
, if their encoded bytes are the
same, then it must be the case that structuralValue(x).equals(structuralValue(y))
.
Most notably:
null
should be a proper object with an
equals()
method, even if the input value is null
.
See also Coder.consistentWithEquals()
.
By default, if this coder is Coder.consistentWithEquals()
, and the value is not null,
returns the provided object. Otherwise, encodes the value into a byte[]
, and returns an
object that performs array equality on the encoded bytes.
structuralValue
in class Coder<TimestampedValue<T>>
public void encode(TimestampedValue<T> windowedElem, java.io.OutputStream outStream) throws 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<TimestampedValue<T>>
java.io.IOException
- if writing to the OutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reasonpublic TimestampedValue<T> decode(java.io.InputStream inStream) throws 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<TimestampedValue<T>>
java.io.IOException
- if reading from the InputStream
fails for some reasonCoderException
- if the value could not be decoded for some reasonpublic void verifyDeterministic() throws Coder.NonDeterministicException
Coder
Coder.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.
verifyDeterministic
in class Coder<TimestampedValue<T>>
Coder.NonDeterministicException
- if this coder is not deterministic.public java.util.List<? extends Coder<?>> getCoderArguments()
Coder
Coder
for a parameterized type, returns the list of Coder
s being
used for each of the parameters in the same order they appear within the parameterized type's
type signature. If this cannot be done, or this Coder
does not encode/decode a
parameterized type, returns the empty list.getCoderArguments
in class Coder<TimestampedValue<T>>
public TypeDescriptor<TimestampedValue<T>> getEncodedTypeDescriptor()
Coder
TypeDescriptor
for the type encoded.getEncodedTypeDescriptor
in class Coder<TimestampedValue<T>>
public java.util.List<? extends Coder<?>> getComponents()
StructuredCoder
Coders
that are components of this Coder
.
The default components will be equal to the value returned by Coder.getCoderArguments()
.
getComponents
in class StructuredCoder<TimestampedValue<T>>