Package org.restlet.ext.html

Class HtmlConverter

java.lang.Object

org.restlet.engine.Helper

org.restlet.engine.converter.ConverterHelper

org.restlet.ext.html.HtmlConverter

public class HtmlConverter
extends ConverterHelper

Converter between the HTML API and Representation classes.

Field Summary

Fields

Modifier and Type	Field	Description
private static VariantInfo	VARIANT_MULTIPART
private static VariantInfo	VARIANT_WWW_FORM

Constructor Summary

Constructors

Constructor	Description
HtmlConverter()

Method Summary

Modifier and Type	Method	Description
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.
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_MULTIPART

private static final VariantInfo VARIANT_MULTIPART

VARIANT_WWW_FORM

private static final VariantInfo VARIANT_WWW_FORM

Constructor Detail

HtmlConverter

public HtmlConverter()

Method Detail

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.

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.