Class UnionCoder
- java.lang.Object
-
- org.apache.beam.sdk.coders.Coder<T>
-
- org.apache.beam.sdk.coders.StructuredCoder<RawUnionValue>
-
- org.apache.beam.sdk.transforms.join.UnionCoder
-
- All Implemented Interfaces:
java.io.Serializable
public class UnionCoder extends StructuredCoder<RawUnionValue>
A UnionCoder encodes RawUnionValues.- 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 RawUnionValue
decode(java.io.InputStream inStream)
Decodes a value of typeT
from the given input stream in the given context.RawUnionValue
decode(java.io.InputStream inStream, Coder.Context context)
Decodes a value of typeT
from the given input stream in the given context.void
encode(RawUnionValue union, java.io.OutputStream outStream)
Encodes the given value of typeT
onto the given output stream.void
encode(RawUnionValue union, 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<? extends Coder<?>>
getCoderArguments()
java.util.List<? extends Coder<?>>
getComponents()
java.util.List<? extends Coder<?>>
getElementCoders()
boolean
isRegisterByteSizeObserverCheap(RawUnionValue union)
Since this coder uses elementCoders.get(index) and coders that are known to run in constant time, we defer the return value to that coder.static UnionCoder
of(java.util.List<Coder<?>> elementCoders)
Builds a union coder with the given list of element coders.void
registerByteSizeObserver(RawUnionValue union, ElementByteSizeObserver observer)
Notifies ElementByteSizeObserver about the byte size of the encoded value using this coder.void
verifyDeterministic()
ThrowCoder.NonDeterministicException
if the coding is not deterministic.-
Methods inherited from class org.apache.beam.sdk.coders.StructuredCoder
equals, hashCode, toString
-
Methods inherited from class org.apache.beam.sdk.coders.Coder
consistentWithEquals, getEncodedElementByteSize, getEncodedTypeDescriptor, structuralValue, verifyDeterministic, verifyDeterministic
-
-
-
-
Method Detail
-
of
public static UnionCoder of(java.util.List<Coder<?>> elementCoders)
Builds a union coder with the given list of element coders. This list corresponds to a mapping of union tag to Coder. Union tags start at 0.
-
encode
public void encode(RawUnionValue union, 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<RawUnionValue>
- 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(RawUnionValue union, 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<RawUnionValue>
- Throws:
java.io.IOException
- if writing to theOutputStream
fails for some reasonCoderException
- if the value could not be encoded for some reason
-
decode
public RawUnionValue 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<RawUnionValue>
- Throws:
java.io.IOException
- if reading from theInputStream
fails for some reasonCoderException
- if the value could not be decoded for some reason
-
decode
public RawUnionValue 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<RawUnionValue>
- 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<? extends Coder<?>> 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<RawUnionValue>
-
getComponents
public java.util.List<? extends Coder<?>> getComponents()
Description copied from class:StructuredCoder
Returns the list ofCoders
that are components of thisCoder
.The default components will be equal to the value returned by
Coder.getCoderArguments()
.- Overrides:
getComponents
in classStructuredCoder<RawUnionValue>
-
getElementCoders
public java.util.List<? extends Coder<?>> getElementCoders()
-
isRegisterByteSizeObserverCheap
public boolean isRegisterByteSizeObserverCheap(RawUnionValue union)
Since this coder uses elementCoders.get(index) and coders that are known to run in constant time, we defer the return value to that coder.- Overrides:
isRegisterByteSizeObserverCheap
in classCoder<RawUnionValue>
-
registerByteSizeObserver
public void registerByteSizeObserver(RawUnionValue union, ElementByteSizeObserver observer) throws java.lang.Exception
Notifies ElementByteSizeObserver about the byte size of the encoded value using this coder.- Overrides:
registerByteSizeObserver
in classCoder<RawUnionValue>
- Throws:
java.lang.Exception
-
verifyDeterministic
public void verifyDeterministic() throws Coder.NonDeterministicException
Description copied from class:Coder
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.
- Specified by:
verifyDeterministic
in classCoder<RawUnionValue>
- Throws:
Coder.NonDeterministicException
- if this coder is not deterministic.
- two values that compare as equal (via
-
-