public class ShardedKeyCoder<KeyT> extends StructuredCoder<ShardedKey<KeyT>>
Coder.Context, Coder.NonDeterministicException
Modifier | Constructor and Description |
---|---|
protected |
ShardedKeyCoder(Coder<KeyT> keyCoder) |
Modifier and Type | Method and Description |
---|---|
ShardedKey<KeyT> |
decode(java.io.InputStream inStream)
Decodes a value of type
T from the given input stream in the given context. |
void |
encode(ShardedKey<KeyT> key,
java.io.OutputStream outStream)
Encodes the given value of type
T onto the given output stream. |
java.util.List<? extends Coder<?>> |
getCoderArguments()
|
static <KeyT> ShardedKeyCoder<KeyT> |
of(Coder<KeyT> keyCoder) |
void |
verifyDeterministic()
Throw
Coder.NonDeterministicException if the coding is not deterministic. |
equals, getComponents, hashCode, toString
consistentWithEquals, decode, encode, getEncodedElementByteSize, getEncodedTypeDescriptor, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic
public static <KeyT> ShardedKeyCoder<KeyT> of(Coder<KeyT> keyCoder)
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<ShardedKey<KeyT>>
public void encode(ShardedKey<KeyT> key, 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<ShardedKey<KeyT>>
java.io.IOException
- if writing to the OutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reasonpublic ShardedKey<KeyT> 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<ShardedKey<KeyT>>
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<ShardedKey<KeyT>>
Coder.NonDeterministicException
- if this coder is not deterministic.