Package org.apache.beam.sdk.coders
Class TextualIntegerCoder
- java.lang.Object
-
- org.apache.beam.sdk.coders.Coder<T>
-
- org.apache.beam.sdk.coders.StructuredCoder<T>
-
- org.apache.beam.sdk.coders.AtomicCoder<java.lang.Integer>
-
- org.apache.beam.sdk.coders.TextualIntegerCoder
-
- All Implemented Interfaces:
java.io.Serializable
public class TextualIntegerCoder extends AtomicCoder<java.lang.Integer>
ACoder
that encodesInteger 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Integer
decode(java.io.InputStream inStream)
Decodes a value of typeT
from the given input stream in the given context.java.lang.Integer
decode(java.io.InputStream inStream, Coder.Context context)
Decodes a value of typeT
from the given input stream in the given context.void
encode(java.lang.Integer value, java.io.OutputStream outStream)
Encodes the given value of typeT
onto the given output stream.void
encode(java.lang.Integer value, java.io.OutputStream outStream, Coder.Context context)
Encodes the given value of typeT
onto the given output stream in the given context.protected long
getEncodedElementByteSize(java.lang.Integer value)
Returns the size in bytes of the encoded value using this coder.TypeDescriptor<java.lang.Integer>
getEncodedTypeDescriptor()
Returns theTypeDescriptor
for the type encoded.static TextualIntegerCoder
of()
void
verifyDeterministic()
ThrowCoder.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, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic
-
-
-
-
Method Detail
-
of
public static TextualIntegerCoder of()
-
encode
public void encode(java.lang.Integer value, java.io.OutputStream outStream) throws java.io.IOException, CoderException
Description copied from class:Coder
Encodes the given value of typeT
onto the given output stream.- Specified by:
encode
in classCoder<java.lang.Integer>
- Throws:
java.io.IOException
- if writing to theOutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reason
-
encode
public void encode(java.lang.Integer value, java.io.OutputStream outStream, Coder.Context context) throws java.io.IOException, CoderException
Description copied from class:Coder
Encodes the given value of typeT
onto the given output stream in the given context.- Overrides:
encode
in classCoder<java.lang.Integer>
- Throws:
java.io.IOException
- if writing to theOutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reason
-
decode
public java.lang.Integer decode(java.io.InputStream inStream) throws java.io.IOException, CoderException
Description copied from class:Coder
Decodes a value of typeT
from the given input stream in the given context. Returns the decoded value.- Specified by:
decode
in classCoder<java.lang.Integer>
- Throws:
java.io.IOException
- if reading from theInputStream
fails for some reasonCoderException
- if the value could not be decoded for some reason
-
decode
public java.lang.Integer decode(java.io.InputStream inStream, Coder.Context context) throws java.io.IOException, CoderException
Description copied from class:Coder
Decodes a value of typeT
from the given input stream in the given context. Returns the decoded value.- Overrides:
decode
in classCoder<java.lang.Integer>
- Throws:
java.io.IOException
- if reading from theInputStream
fails for some reasonCoderException
- if the value could not be decoded for some reason
-
verifyDeterministic
public void verifyDeterministic()
Description copied from class:AtomicCoder
ThrowCoder.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()
orComparable.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 classAtomicCoder<java.lang.Integer>
- two values that compare as equal (via
-
getEncodedTypeDescriptor
public TypeDescriptor<java.lang.Integer> getEncodedTypeDescriptor()
Description copied from class:Coder
Returns theTypeDescriptor
for the type encoded.- Overrides:
getEncodedTypeDescriptor
in classCoder<java.lang.Integer>
-
getEncodedElementByteSize
protected long getEncodedElementByteSize(java.lang.Integer value) throws java.lang.Exception
Description copied from class:Coder
Returns the size in bytes of the encoded value using this coder.- Overrides:
getEncodedElementByteSize
in classCoder<java.lang.Integer>
- Throws:
java.lang.Exception
-
-