Package org.apache.beam.sdk.coders

Class TextualIntegerCoder

java.lang.Object

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

org.apache.beam.sdk.coders.StructuredCoder<Integer>

org.apache.beam.sdk.coders.AtomicCoder<Integer>

org.apache.beam.sdk.coders.TextualIntegerCoder

All Implemented Interfaces:

Serializable

public class TextualIntegerCoder
extends AtomicCoder<Integer>

A Coder that encodes Integer Integers as the ASCII bytes of their textual, decimal, representation.

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	Description
protected	TextualIntegerCoder()

Method Summary

Modifier and Type	Method	Description
Integer	decode(InputStream inStream)	Decodes a value of type T from the given input stream in the given context.
Integer	decode(InputStream inStream, Coder.Context context)	Decodes a value of type T from the given input stream in the given context.
void	encode(Integer value, OutputStream outStream)	Encodes the given value of type T onto the given output stream.
void	encode(Integer value, OutputStream outStream, Coder.Context context)	Encodes the given value of type T onto the given output stream in the given context.
protected long	getEncodedElementByteSize(Integer value)	Returns the size in bytes of the encoded value using this coder.
TypeDescriptor<Integer>	getEncodedTypeDescriptor()	Returns the TypeDescriptor for the type encoded.
static TextualIntegerCoder	of()
void	verifyDeterministic()	Throw Coder.NonDeterministicException if the coding is not deterministic.

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

equals, getCoderArguments, getComponents, hashCode

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

toString

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

consistentWithEquals, getEncodedElementByteSizeUsingCoder, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Constructor Details

TextualIntegerCoder

protected TextualIntegerCoder()

Method Details

of

public static TextualIntegerCoder of()

encode

public void encode(Integer value,
 OutputStream outStream)
            throws IOException,
CoderException

Description copied from class: Coder

Encodes the given value of type 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.

Specified by:

encode in class Coder<Integer>

Throws:

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(Integer value,
 OutputStream outStream,
 Coder.Context context)
            throws IOException,
CoderException

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<Integer>

Throws:

IOException - if writing to the OutputStream fails for some reason

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

decode

public Integer decode(InputStream inStream)
               throws IOException,
CoderException

Description copied from class: Coder

Decodes a value of type 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.

Specified by:

decode in class Coder<Integer>

Throws:

IOException - if reading from the InputStream fails for some reason

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

decode

public Integer decode(InputStream inStream,
 Coder.Context context)
               throws IOException,
CoderException

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<Integer>

Throws:

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()

Description copied from class: AtomicCoder

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.

.

Unless overridden, does not throw. An AtomicCoder is presumed to be deterministic

Overrides:

verifyDeterministic in class AtomicCoder<Integer>

getEncodedTypeDescriptor

public TypeDescriptor<Integer> getEncodedTypeDescriptor()

Description copied from class: Coder

Returns the TypeDescriptor for the type encoded.

Overrides:

getEncodedTypeDescriptor in class Coder<Integer>

getEncodedElementByteSize

protected long getEncodedElementByteSize(Integer value)
                                  throws Exception

Description copied from class: Coder

Returns the size in bytes of the encoded value using this coder.

Overrides:

getEncodedElementByteSize in class Coder<Integer>

Throws:

Exception