Package org.restlet.ext.jackson

Class JacksonConverter

java.lang.Object

org.restlet.engine.Helper

org.restlet.engine.converter.ConverterHelper

org.restlet.ext.jackson.JacksonConverter

public class JacksonConverter
extends ConverterHelper

Converter between the JSON, JSON Smile, CSV, XML, YAML and Representation classes based on Jackson.

Field Summary

Fields

Modifier and Type	Field	Description
private static VariantInfo	VARIANT_APPLICATION_XML	Variant with media type application/xml.
private static VariantInfo	VARIANT_APPLICATION_YAML	Variant with media type application/yaml.
private static VariantInfo	VARIANT_JSON	Variant with media type application/json.
private static VariantInfo	VARIANT_JSON_SMILE	Variant with media type application/x-json-smile.
private static VariantInfo	VARIANT_TEXT_CSV	Variant with media type text/csv.
private static VariantInfo	VARIANT_TEXT_XML	Variant with media type text/xml.
private static VariantInfo	VARIANT_TEXT_YAML	Variant with media type text/yaml.

Constructor Summary

Constructors

Constructor	Description
JacksonConverter()

Method Summary

Modifier and Type	Method	Description
protected <T> JacksonRepresentation<T>	create(MediaType mediaType, T source)	Creates the marshaling JacksonRepresentation.
protected <T> JacksonRepresentation<T>	create(Representation source, java.lang.Class<T> objectClass)	Creates the unmarshaling JacksonRepresentation.
java.util.List<java.lang.Class<?>>	getObjectClasses(Variant source)	Returns the list of object classes that can be converted from a given variant.
java.util.List<VariantInfo>	getVariants(java.lang.Class<?> source)	Returns the list of variants that can be converted from a given object class.
protected boolean	isCompatible(Variant variant)	Indicates if the given variant is compatible with the media types supported by this converter.
float	score(java.lang.Object source, Variant target, Resource resource)	Scores the affinity of this helper with the source class.
<T> float	score(Representation source, java.lang.Class<T> target, Resource resource)	Scores the affinity of this helper with the source class.
<T> T	toObject(Representation source, java.lang.Class<T> target, Resource resource)	Converts a Representation into a regular Java object.
Representation	toRepresentation(java.lang.Object source, Variant target, Resource resource)	Converts a regular Java object into a Representation.
<T> void	updatePreferences(java.util.List<Preference<MediaType>> preferences, java.lang.Class<T> entity)	Updates the preferences of the given ClientInfo object with conversion capabilities for the given entity class.

Methods inherited from class org.restlet.engine.converter.ConverterHelper

addObjectClass, addVariant, addVariants, getVariants, updatePreferences

Methods inherited from class java.lang.Object

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

Field Detail

VARIANT_APPLICATION_XML

private static final VariantInfo VARIANT_APPLICATION_XML

Variant with media type application/xml.

VARIANT_APPLICATION_YAML

private static final VariantInfo VARIANT_APPLICATION_YAML

Variant with media type application/yaml.

VARIANT_JSON

private static final VariantInfo VARIANT_JSON

Variant with media type application/json.

VARIANT_JSON_SMILE

private static final VariantInfo VARIANT_JSON_SMILE

Variant with media type application/x-json-smile.

VARIANT_TEXT_CSV

private static final VariantInfo VARIANT_TEXT_CSV

Variant with media type text/csv.

VARIANT_TEXT_XML

private static final VariantInfo VARIANT_TEXT_XML

Variant with media type text/xml.

VARIANT_TEXT_YAML

private static final VariantInfo VARIANT_TEXT_YAML

Variant with media type text/yaml.

Constructor Detail

JacksonConverter

public JacksonConverter()

Method Detail

create

protected <T> JacksonRepresentation<T> create(MediaType mediaType,
                                              T source)

Creates the marshaling JacksonRepresentation.

Type Parameters:

T -

Parameters:

mediaType - The target media type.

source - The source object to marshal.

Returns:

The marshaling JacksonRepresentation.

create

protected <T> JacksonRepresentation<T> create(Representation source,
                                              java.lang.Class<T> objectClass)

Creates the unmarshaling JacksonRepresentation.

Type Parameters:

T -

Parameters:

source - The source representation to unmarshal.

objectClass - The object class to instantiate.

Returns:

The unmarshaling JacksonRepresentation.

getObjectClasses

public java.util.List<java.lang.Class<?>> getObjectClasses(Variant source)

Description copied from class: ConverterHelper

Returns the list of object classes that can be converted from a given variant.

Specified by:

getObjectClasses in class ConverterHelper

Parameters:

source - The source variant.

Returns:

The list of object class that can be converted.

getVariants

public java.util.List<VariantInfo> getVariants(java.lang.Class<?> source)

Description copied from class: ConverterHelper

Returns the list of variants that can be converted from a given object class. The preferred variant should be set in first position.

Specified by:

getVariants in class ConverterHelper

Parameters:

source - The source object class.

Returns:

The list of variants that can be converted.

isCompatible

protected boolean isCompatible(Variant variant)

Indicates if the given variant is compatible with the media types supported by this converter.

Parameters:

variant - The variant.

Returns:

True if the given variant is compatible with the media types supported by this converter.

score

public float score(java.lang.Object source,
                   Variant target,
                   Resource resource)

Description copied from class: ConverterHelper

Scores the affinity of this helper with the source class.

Specified by:

score in class ConverterHelper

Parameters:

source - The source object to convert.

target - The expected representation metadata.

resource - The calling resource.

Returns:

The affinity score of this helper.

score

public <T> float score(Representation source,
                       java.lang.Class<T> target,
                       Resource resource)

Description copied from class: ConverterHelper

Scores the affinity of this helper with the source class.

Specified by:

score in class ConverterHelper

Parameters:

source - The source representation to convert.

target - The expected class of the Java object.

resource - The calling resource.

Returns:

The affinity score of this helper.

toObject

public <T> T toObject(Representation source,
                      java.lang.Class<T> target,
                      Resource resource)
               throws java.io.IOException

Description copied from class: ConverterHelper

Converts a Representation into a regular Java object.

Specified by:

toObject in class ConverterHelper

Type Parameters:

T - The expected class of the Java object.

Parameters:

source - The source representation to convert.

target - The expected class of the Java object.

resource - The calling resource.

Returns:

The converted Java object.

Throws:

java.io.IOException

toRepresentation

public Representation toRepresentation(java.lang.Object source,
                                       Variant target,
                                       Resource resource)

Description copied from class: ConverterHelper

Converts a regular Java object into a Representation.

Specified by:

toRepresentation in class ConverterHelper

Parameters:

source - The source object to convert.

target - The expected representation metadata.

resource - The calling resource.

Returns:

The converted representation.

updatePreferences

public <T> void updatePreferences(java.util.List<Preference<MediaType>> preferences,
                                  java.lang.Class<T> entity)

Description copied from class: ConverterHelper

Updates the preferences of the given ClientInfo object with conversion capabilities for the given entity class.

Overrides:

updatePreferences in class ConverterHelper

Parameters:

preferences - The media type preferences.

entity - The entity class to convert.