org.apache.beam.sdk.values

Class ValueWithRecordId.ValueWithRecordIdCoder<ValueT>

java.lang.Object

org.apache.beam.sdk.coders.Coder<T>

org.apache.beam.sdk.coders.StructuredCoder<ValueWithRecordId<ValueT>>

org.apache.beam.sdk.values.ValueWithRecordId.ValueWithRecordIdCoder<ValueT>

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

ValueWithRecordId<ValueT>

public static class ValueWithRecordId.ValueWithRecordIdCoder<ValueT>
extends StructuredCoder<ValueWithRecordId<ValueT>>

A Coder for ValueWithRecordId, using a wrapped value Coder.

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

Modifier	Constructor and Description
protected	ValueWithRecordIdCoder(Coder<ValueT> valueCoder)

Method Summary

Modifier and Type	Method and Description
ValueWithRecordId<ValueT>	decode(java.io.InputStream inStream) Decodes a value of type T from the given input stream in the given context.
ValueWithRecordId<ValueT>	decode(java.io.InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(ValueWithRecordId<ValueT> value, java.io.OutputStream outStream) Encodes the given value of type T onto the given output stream.
void	encode(ValueWithRecordId<ValueT> value, java.io.OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
java.util.List<? extends Coder<?>>	getCoderArguments() If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters in the same order they appear within the parameterized type's type signature.
Coder<ValueT>	getValueCoder()
static <ValueT> ValueWithRecordId.ValueWithRecordIdCoder<ValueT>	of(Coder<ValueT> valueCoder)
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.

Methods inherited from class org.apache.beam.sdk.coders.StructuredCoder

consistentWithEquals, equals, getComponents, getEncodedTypeDescriptor, hashCode, structuralValue, toString

Methods inherited from class org.apache.beam.sdk.coders.Coder

getEncodedElementByteSize, isRegisterByteSizeObserverCheap, registerByteSizeObserver, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ValueWithRecordIdCoder

protected ValueWithRecordIdCoder(Coder<ValueT> valueCoder)

Method Detail

of

public static <ValueT> ValueWithRecordId.ValueWithRecordIdCoder<ValueT> of(Coder<ValueT> valueCoder)

getCoderArguments

public java.util.List<? extends Coder<?>> getCoderArguments()

Description copied from class: Coder

If this is a Coder for a parameterized type, returns the list of Coders 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.

Specified by:

getCoderArguments in class Coder<ValueWithRecordId<ValueT>>

encode

public void encode(ValueWithRecordId<ValueT> value,
                   java.io.OutputStream outStream)
            throws java.io.IOException

Description copied from class: Coder

Encodes the given value of type T onto the given output stream.

Specified by:

encode in class Coder<ValueWithRecordId<ValueT>>

Throws:

java.io.IOException - if writing to the OutputStream fails for some reason

CoderException - if the value could not be encoded for some reason

encode

public void encode(ValueWithRecordId<ValueT> value,
                   java.io.OutputStream outStream,
                   Coder.Context context)
            throws java.io.IOException

Description copied from class: Coder

Encodes the given value of type T onto the given output stream in the given context.

Overrides:

encode in class Coder<ValueWithRecordId<ValueT>>

Throws:

java.io.IOException - if writing to the OutputStream fails for some reason

CoderException - if the value could not be encoded for some reason

decode

public ValueWithRecordId<ValueT> decode(java.io.InputStream inStream)
                                 throws java.io.IOException

Description copied from class: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value.

Specified by:

decode in class Coder<ValueWithRecordId<ValueT>>

Throws:

java.io.IOException - if reading from the InputStream fails for some reason

CoderException - if the value could not be decoded for some reason

decode

public ValueWithRecordId<ValueT> decode(java.io.InputStream inStream,
                                        Coder.Context context)
                                 throws java.io.IOException

Description copied from class: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value.

Overrides:

decode in class Coder<ValueWithRecordId<ValueT>>

Throws:

java.io.IOException - if reading from the InputStream fails for some reason

CoderException - if the value could not be decoded for some reason

verifyDeterministic

public void verifyDeterministic()
                         throws Coder.NonDeterministicException

Description copied from class: Coder

Throw Coder.NonDeterministicException if the coding is not deterministic.

In order for a Coder to be considered deterministic, the following must be true:

• two values that compare as equal (via Object.equals() or Comparable.compareTo(), if supported) have the same encoding.
• the 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.

Specified by:

verifyDeterministic in class Coder<ValueWithRecordId<ValueT>>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.

getValueCoder

public Coder<ValueT> getValueCoder()