net.java.trueupdate.core.codec
Class JaxbCodec

java.lang.Object
  net.java.trueupdate.core.codec.JaxbCodec

All Implemented Interfaces:

Codec

@Immutable
public class JaxbCodec
extends Object
implements Codec

A codec which encodes/decodes objects to/from XML with a Marshaller/Unmarshaller derived from a JAXBContext.

This type of codec does not support encoding or decoding null.

Author:

Christian Schlichtherle (copied and edited from TrueLicense Core 2.3.1)

context

protected final JAXBContext context

The JAXB context provided to the constructor.

JaxbCodec

public JaxbCodec(JAXBContext context)

contentTransferEncoding

public String contentTransferEncoding()

Returns an identifier for the content transfer encoding used by this codec. The returned string must conform to the syntax specified in RFC2045 "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies", Section 6.1 "Content-Transfer-Encoding Syntax", except that it must not start with "Content-Transfer-Encoding:" and optional spaces, i.e. the field name must be stripped.

If the Content-Transfer-Encoding equals (ignoring case) "8bit" and the Content-Type does not specify a charset parameter, then UTF-8 is assumed as the charset.

The implementation in the class JaxbCodec returns "8bit".

Specified by:

contentTransferEncoding in interface Codec

See Also:

RFC 3023

contentType

public String contentType()

Returns an identifier for the content type used by this codec. The returned string must conform to the syntax specified in RFC2045 "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies", Section 5.1 "Syntax of the Content-Type Header Field", except that it must not start with "Content-Type:" and optional spaces, i.e. the field name is stripped.

The implementation in the class JaxbCodec returns "application/xml; charset=utf-8".

Specified by:

contentType in interface Codec

See Also:

RFC 3023

decode

public <T> T decode(Source source,
                    Type expected)
         throws Exception

Description copied from interface: Codec

Decodes a nullable object graph from the given source.

Specified by:

decode in interface Codec

Type Parameters:

T - the expected generic type of the decoded object.

Parameters:

source - the source from where to read the encoded object graph from.

expected - the expected generic type of the decoded object graph, e.g. String.class. This is just a hint and the implementation may ignore it.

Returns:

A duplicate of the original object graph. Its actual type may differ from the expected generic type. It may be null if and only if the original object graph was null.

Throws:

Exception

encode

public void encode(Sink sink,
                   Object obj)
            throws Exception

Description copied from interface: Codec

Encodes a nullable object graph to the given sink.

Specified by:

encode in interface Codec

Parameters:

sink - the sink to write the encoded object graph to.

obj - the nullable object graph. Implementations should support encoding null. If they do not support this, then this should be documented in the Javadoc.

Throws:

Exception

marshaller

protected Marshaller marshaller()
                         throws JAXBException

Returns a new marshaller.

Throws:

JAXBException

unmarshaller

protected Unmarshaller unmarshaller()
                             throws JAXBException

Returns a new unmarshaller.

Throws:

JAXBException