Class NullableCoder<T>
- java.lang.Object
-
- org.apache.beam.sdk.coders.Coder<T>
-
- org.apache.beam.sdk.coders.StructuredCoder<@Nullable T>
-
- org.apache.beam.sdk.coders.NullableCoder<T>
-
- Type Parameters:
T
- the type of the values being transcoded
- All Implemented Interfaces:
java.io.Serializable
public class NullableCoder<T> extends StructuredCoder<@Nullable T>
ANullableCoder
encodes nullable values of typeT
using a nestedCoder<T>
that does not toleratenull
values.NullableCoder
uses exactly 1 byte per entry to indicate whether the value isnull
, then adds the encoding of the inner coder for non-null values.- 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()
NullableCoder
is consistent with equals if the nestedCoder
is.@Nullable T
decode(java.io.InputStream inStream)
Decodes a value of typeT
from the given input stream in the given context.@Nullable T
decode(java.io.InputStream inStream, Coder.Context context)
Decodes a value of typeT
from the given input stream in the given context.void
encode(@Nullable T value, java.io.OutputStream outStream)
Encodes the given value of typeT
onto the given output stream.void
encode(@Nullable T value, java.io.OutputStream outStream, Coder.Context context)
Encodes the given value of typeT
onto the given output stream in the given context.java.util.List<Coder<T>>
getCoderArguments()
protected long
getEncodedElementByteSize(@Nullable T value)
Overridden to short-circuit the defaultStructuredCoder
behavior of encoding and counting the bytes.TypeDescriptor<@Nullable T>
getEncodedTypeDescriptor()
Returns theTypeDescriptor
for the type encoded.Coder<T>
getValueCoder()
Returns the innerCoder
wrapped by thisNullableCoder
instance.boolean
isRegisterByteSizeObserverCheap(@Nullable T value)
NullableCoder
is cheap ifvalueCoder
is cheap.static <T> NullableCoder<T>
of(Coder<T> valueCoder)
void
registerByteSizeObserver(@Nullable T value, ElementByteSizeObserver observer)
Overridden to short-circuit the defaultStructuredCoder
behavior of encoding and counting the bytes.java.lang.Object
structuralValue(@Nullable T value)
Returns an object with anObject.equals()
method that represents structural equality on the argument.void
verifyDeterministic()
NullableCoder
is deterministic if the nestedCoder
is.-
Methods inherited from class org.apache.beam.sdk.coders.StructuredCoder
equals, getComponents, hashCode, toString
-
Methods inherited from class org.apache.beam.sdk.coders.Coder
verifyDeterministic, verifyDeterministic
-
-
-
-
Method Detail
-
of
public static <T> NullableCoder<T> of(Coder<T> valueCoder)
-
getValueCoder
public Coder<T> getValueCoder()
Returns the innerCoder
wrapped by thisNullableCoder
instance.
-
encode
public void encode(@Nullable T 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<@Nullable T>
- 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(@Nullable T 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<@Nullable T>
- Throws:
java.io.IOException
- if writing to theOutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reason
-
decode
public @Nullable T 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<@Nullable T>
- Throws:
java.io.IOException
- if reading from theInputStream
fails for some reasonCoderException
- if the value could not be decoded for some reason
-
decode
public @Nullable T 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<@Nullable T>
- Throws:
java.io.IOException
- if reading from theInputStream
fails for some reasonCoderException
- if the value could not be decoded for some reason
-
getCoderArguments
public java.util.List<Coder<T>> getCoderArguments()
Description copied from class:Coder
If this is aCoder
for a parameterized type, returns the list ofCoder
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 thisCoder
does not encode/decode a parameterized type, returns the empty list.- Specified by:
getCoderArguments
in classCoder<@Nullable T>
-
verifyDeterministic
public void verifyDeterministic() throws Coder.NonDeterministicException
NullableCoder
is deterministic if the nestedCoder
is.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()
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.
- Specified by:
verifyDeterministic
in classCoder<@Nullable T>
- Throws:
Coder.NonDeterministicException
- if this coder is not deterministic.
- two values that compare as equal (via
-
consistentWithEquals
public boolean consistentWithEquals()
NullableCoder
is consistent with equals if the nestedCoder
is.Returns
true
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<@Nullable T>
-
structuralValue
public java.lang.Object structuralValue(@Nullable T value)
Description copied from class:Coder
Returns an object with anObject.equals()
method that represents structural equality on the argument.For any two values
x
andy
of typeT
, if their encoded bytes are the same, then it must be the case thatstructuralValue(x).equals(structuralValue(y))
.Most notably:
- The structural value for an array coder should perform a structural comparison of the contents of the arrays, rather than the default behavior of comparing according to object identity.
- The structural value for a coder accepting
null
should be a proper object with anequals()
method, even if the input value isnull
.
See also
Coder.consistentWithEquals()
.By default, if this coder is
Coder.consistentWithEquals()
, and the value is not null, returns the provided object. Otherwise, encodes the value into abyte[]
, and returns an object that performs array equality on the encoded bytes.- Overrides:
structuralValue
in classCoder<@Nullable T>
-
registerByteSizeObserver
public void registerByteSizeObserver(@Nullable T value, ElementByteSizeObserver observer) throws java.lang.Exception
Overridden to short-circuit the defaultStructuredCoder
behavior of encoding and counting the bytes. The size is known (1 byte) whenvalue
isnull
, otherwise the size is 1 byte plus the size of nestedCoder
's encoding ofvalue
.Notifies the
ElementByteSizeObserver
about the byte size of the encoded value using thisCoder
.Not intended to be called by user code, but instead by
PipelineRunner
implementations.By default, this notifies
observer
about the byte size of the encoded value using this coder as returned byCoder.getEncodedElementByteSize(T)
.- Overrides:
registerByteSizeObserver
in classCoder<@Nullable T>
- Throws:
java.lang.Exception
-
getEncodedElementByteSize
protected long getEncodedElementByteSize(@Nullable T value) throws java.lang.Exception
Overridden to short-circuit the defaultStructuredCoder
behavior of encoding and counting the bytes. The size is known (1 byte) whenvalue
isnull
, otherwise the size is 1 byte plus the size of nestedCoder
's encoding ofvalue
.Returns the size in bytes of the encoded value using this coder.
- Overrides:
getEncodedElementByteSize
in classCoder<@Nullable T>
- Throws:
java.lang.Exception
-
isRegisterByteSizeObserverCheap
public boolean isRegisterByteSizeObserverCheap(@Nullable T value)
NullableCoder
is cheap ifvalueCoder
is cheap.Returns whether
Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)
cheap enough to call for every element, that is, if thisCoder
can calculate the byte size of the element to be coded in roughly constant time (or lazily).Not intended to be called by user code, but instead by
PipelineRunner
implementations.By default, returns false. The default
Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver)
implementation invokesCoder.getEncodedElementByteSize(T)
which requires re-encoding an element unless it is overridden. This is considered expensive.- Overrides:
isRegisterByteSizeObserverCheap
in classCoder<@Nullable T>
-
getEncodedTypeDescriptor
public TypeDescriptor<@Nullable T> getEncodedTypeDescriptor()
Description copied from class:Coder
Returns theTypeDescriptor
for the type encoded.- Overrides:
getEncodedTypeDescriptor
in classCoder<@Nullable T>
-
-