org.nuiton.util.converter

Interface FormatConverter<A>

Type Parameters:

A - le type de l'objet a convertir

public interface FormatConverter<A>

Un converter est un objet qui permet de passé d'une representation d'un objet vers une autre representation. Le mininum que converter doit savoir faire, est de converter une representation Java vers le format qu'il gère et inversement. Pour des raisons d'optimisation, il est possible qu'un converter sache passé d'un autre type que java vers sa representation pour eviter une conversion supplémentaire qui pourrait-etre couteuse.

Field Summary

Fields

Modifier and Type	Field and Description
static FormatMap.Format	FORMAT_JAVA

Method Summary

Methods

Modifier and Type	Method and Description
A	convert(FormatConverterFactory factory, FormatMap.Format format, FormatMap values, Object... args) Convertie une valeur vers la representation FORMAT géré par cette classe
Object	unconvert(FormatConverterFactory factory, FormatMap.Format format, FormatMap values, Object... args) Convertie une valeur vers le Java

Field Detail

FORMAT_JAVA

static final FormatMap.Format FORMAT_JAVA

Method Detail

convert

A convert(FormatConverterFactory factory,
        FormatMap.Format format,
        FormatMap values,
        Object... args)

Convertie une valeur vers la representation FORMAT géré par cette classe

Parameters:

factory - la factory utilisable pour rechercher d'autre converter si la representation Java n'est pas presente dans values et que l'on en a besoin

format - le format souhaité en sortie

values - une map contenant les différentes representation de la meme valeur. Les cles de la map sont les valeurs retournés par la methode getFormat().

args - des arguments qui peuvent-être utile pour la conversion. par exemple si dans une application on a construit son propre converter et que pour la conversion, on a besoin d'un Context applicatif il peut-etre passé dans les args. Si le converter a besoin d'autre converter les memes args lui seront passé.

Returns:

l'objet dans la representation demandés par type

Throws:

IllegalArgumentException - si auncun moyen n'est trouve pour convertir une des valeurs de values dans le format géré par cette classe. Ou s'il manque dans les args des objets utils pour la conversion.

unconvert

Object unconvert(FormatConverterFactory factory,
               FormatMap.Format format,
               FormatMap values,
               Object... args)

Convertie une valeur vers le Java

Parameters:

factory - la factory utilisable pour rechercher d'autre converter si la representation Java n'est pas presente dans values et que l'on en a besoin

format - le format à utiliser comme valeur d'entré

values - une map contenant les différentes representation de la meme valeur. La valeur interessante dans la map pour cette methode est celle retournée par values.get(getFormat()) si cet appel, ne retourne pas quelque chose de valid, la methode doit lever une exception

args - des arguments qui peuvent-être utile pour la conversion. par exemple si dans une application on a construit son propre converter et que pour la conversion, on a besoin d'un Context applicatif il peut-etre passé dans les args. Si le converter a besoin d'autre converter les memes args lui seront passé.

Returns:

la valeur java

Throws:

IllegalArgumentException - si le format géré par cette classe n'est pas trouvé dans les values. Ou s'il manque dans les args des objets utils pour la conversion.