org.apache.beam.sdk.io.xml

Class JAXBCoder<T>

java.lang.Object

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

org.apache.beam.sdk.coders.CustomCoder<T>

org.apache.beam.sdk.io.xml.JAXBCoder<T>

Type Parameters:

T - type of JAXB annotated objects that will be serialized.

All Implemented Interfaces:

java.io.Serializable

public class JAXBCoder<T>
extends CustomCoder<T>

A coder for JAXB annotated objects. This coder uses JAXB marshalling/unmarshalling mechanisms to encode/decode the objects. Users must provide the Class of the JAXB annotated object.

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

Modifier and Type	Method and Description
T	decode(java.io.InputStream inStream) Decodes a value of type T from the given input stream in the given context.
T	decode(java.io.InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(T value, java.io.OutputStream outStream) Encodes the given value of type T onto the given output stream.
void	encode(T value, java.io.OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
boolean	equals(@Nullable java.lang.Object other)
TypeDescriptor<T>	getEncodedTypeDescriptor() Returns the TypeDescriptor for the type encoded.
java.lang.Class<T>	getJAXBClass()
int	hashCode()
static <T> JAXBCoder<T>	of(java.lang.Class<T> jaxbClass) Create a coder for a given type of JAXB annotated objects.

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

getCoderArguments, verifyDeterministic

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

consistentWithEquals, getEncodedElementByteSize, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Method Detail

getJAXBClass

public java.lang.Class<T> getJAXBClass()

of

public static <T> JAXBCoder<T> of(java.lang.Class<T> jaxbClass)

Create a coder for a given type of JAXB annotated objects.

Parameters:

jaxbClass - the Class of the JAXB annotated objects.

encode

public void encode(T value,
                   java.io.OutputStream outStream)
            throws java.io.IOException

Description copied from class: Coder

Encodes the given value of type T onto the given output stream.

Specified by:

encode in class Coder<T>

Throws:

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

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

Throws:

java.io.IOException - if writing to the OutputStream fails for some reason

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

decode

public T decode(java.io.InputStream inStream)
         throws java.io.IOException

Description copied from class: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value.

Specified by:

decode in class Coder<T>

Throws:

java.io.IOException - if reading from the InputStream fails for some reason

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

decode

public T decode(java.io.InputStream inStream,
                Coder.Context context)
         throws java.io.IOException

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

Throws:

java.io.IOException - if reading from the InputStream fails for some reason

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

getEncodedTypeDescriptor

public TypeDescriptor<T> getEncodedTypeDescriptor()

Description copied from class: Coder

Returns the TypeDescriptor for the type encoded.

Overrides:

getEncodedTypeDescriptor in class Coder<T>

equals

public boolean equals(@Nullable java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object