Package org.apache.beam.sdk.coders
Class StringUtf8Coder
- 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.String>
-
- org.apache.beam.sdk.coders.StringUtf8Coder
-
- All Implemented Interfaces:
java.io.Serializable
public class StringUtf8Coder extends AtomicCoder<java.lang.String>
ACoder
that encodesStrings
in UTF-8 encoding. If in a nested context, prefixes the string with an integer length field, encoded via aVarIntCoder
.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.beam.sdk.coders.Coder
Coder.Context, Coder.NonDeterministicException
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
consistentWithEquals()
java.lang.String
decode(java.io.InputStream inStream)
Decodes a value of typeT
from the given input stream in the given context.java.lang.String
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.String value, java.io.OutputStream outStream)
Encodes the given value of typeT
onto the given output stream.void
encode(java.lang.String value, java.io.OutputStream outStream, Coder.Context context)
Encodes the given value of typeT
onto the given output stream in the given context.long
getEncodedElementByteSize(java.lang.String value)
Returns the size in bytes of the encoded value using this coder.TypeDescriptor<java.lang.String>
getEncodedTypeDescriptor()
Returns theTypeDescriptor
for the type encoded.static StringUtf8Coder
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
isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic
-
-
-
-
Method Detail
-
of
public static StringUtf8Coder of()
-
encode
public void encode(java.lang.String value, java.io.OutputStream outStream) throws java.io.IOException
Description copied from class:Coder
Encodes the given value of typeT
onto the given output stream.- Specified by:
encode
in classCoder<java.lang.String>
- 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.String value, java.io.OutputStream outStream, Coder.Context context) throws java.io.IOException
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.String>
- 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.String decode(java.io.InputStream inStream) throws java.io.IOException
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.String>
- 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.String decode(java.io.InputStream inStream, Coder.Context context) throws java.io.IOException
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.String>
- 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.String>
- two values that compare as equal (via
-
consistentWithEquals
public boolean consistentWithEquals()
Returnstrue
if thisCoder
is injective with respect toObject.equals(java.lang.Object)
.Whenever the encoded bytes of two values are equal, then the original values are equal according to
Objects.equals()
. Note that this is well-defined fornull
.This condition is most notably false for arrays. More generally, this condition is false whenever
equals()
compares object identity, rather than performing a semantic/structural comparison.By default, returns false.
- Overrides:
consistentWithEquals
in classCoder<java.lang.String>
- Returns:
true
. This coder is injective.
-
getEncodedTypeDescriptor
public TypeDescriptor<java.lang.String> getEncodedTypeDescriptor()
Description copied from class:Coder
Returns theTypeDescriptor
for the type encoded.- Overrides:
getEncodedTypeDescriptor
in classCoder<java.lang.String>
-
getEncodedElementByteSize
public long getEncodedElementByteSize(java.lang.String value) throws java.lang.Exception
Returns the size in bytes of the encoded value using this coder.- Overrides:
getEncodedElementByteSize
in classCoder<java.lang.String>
- Returns:
- the byte size of the UTF-8 encoding of the string or, in a nested context, the byte size of the encoding plus the encoded length prefix.
- Throws:
java.lang.Exception
-
-