Package org.infinispan.commons.dataconversion

Class AbstractTranscoder

java.lang.Object

org.infinispan.commons.dataconversion.AbstractTranscoder

All Implemented Interfaces:

Transcoder

Direct Known Subclasses:

DefaultTranscoder, OneToManyTranscoder

public abstract class AbstractTranscoder
extends Object
implements Transcoder

Class to inherit when implementing transcoders, will handle pre and post processing of the content.

Since:

13.0

Constructor Summary

Constructors

Constructor	Description
AbstractTranscoder()

Method Summary

Modifier and Type	Method	Description
protected Object	decodeContent(Object content, MediaType contentType)	Decodes content before doing the transcoding.
protected abstract Object	doTranscode(Object decoded, MediaType contentType, MediaType destinationType)
protected Object	encodeContent(Object content, MediaType destinationType)	Encode the content after transcoding if necessary.
Object	transcode(Object content, MediaType contentType, MediaType destinationType)	Transcodes content between two different MediaType.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commons.dataconversion.Transcoder

getSupportedMediaTypes, supports, supportsConversion

Constructor Detail

AbstractTranscoder

public AbstractTranscoder()

Method Detail

decodeContent

protected Object decodeContent(Object content,
                               MediaType contentType)
                        throws UnsupportedEncodingException

Decodes content before doing the transcoding.

Parameters:

content - the content.

contentType - the MediaType describing the content.

Returns:

an Object with the content decoded or the content itself if no decoding needed.

Throws:

UnsupportedEncodingException - if an invalid encoding or type is provided.

encodeContent

protected Object encodeContent(Object content,
                               MediaType destinationType)
                        throws UnsupportedEncodingException

Encode the content after transcoding if necessary.

Parameters:

content - The content to encode.

destinationType - The destination MediaType

Returns:

The value encoded or unchanged if no encoding is needed.

Throws:

UnsupportedEncodingException

transcode

public Object transcode(Object content,
                        MediaType contentType,
                        MediaType destinationType)

Description copied from interface: Transcoder

Transcodes content between two different MediaType.

Specified by:

transcode in interface Transcoder

Parameters:

content - Content to transcode.

contentType - The MediaType of the content.

destinationType - The target MediaType to convert.

Returns:

the transcoded content.

doTranscode

protected abstract Object doTranscode(Object decoded,
                                      MediaType contentType,
                                      MediaType destinationType)