org.foxlabs.validation.converter

Interface Converter<V>

Type Parameters:

V - The type of value to be converted

All Superinterfaces:

Validation<V>

All Known Implementing Classes:

AbstractConverter, ArrayConverter, BigDecimalConverter, BigIntegerConverter, BooleanConverter, ByteConverter, CharacterConverter, ClassConverter, CollectionConverter, ConverterMessageWrapper, ConverterWrapper, CustomConverter, DateConverter, DoubleConverter, EnumConverter, FileConverter, FloatConverter, IntegerConverter, LocaleConverter, LogLevelConverter, LongConverter, MapConverter, NumberConverter, NumberConverter.DecimalType, NumberConverter.IntegerType, SequenceConverter, ShortConverter, SimpleTokenizer, StringConverter, TimeZoneConverter, Tokenizer, UnsupportedConverter, URIConverter, URLConverter

public interface Converter<V>
extends Validation<V>

The root interface in the converter hierarchy. A converter provides ability to convert values of certain data type into and from string representation. Converter instances should be registered and obtained from ConverterFactory.

Author:

Fox Mulder

See Also:

ConverterFactory

Method Summary

Modifier and Type	Method and Description
boolean	appendMessageArguments(ValidationContext<?> context, Map<String,Object> arguments) Appends arguments to be substituted into the error message template.
<T> V	decode(String value, ValidationContext<T> context) Converts string representation of value into object.
<T> String	encode(V value, ValidationContext<T> context) Converts value into string representation.
String	getMessageTemplate(ValidationContext<?> context) Returns localized error message template.
Class<V>	getType() Returns the type of value to be converted.

Method Detail

getType

Class<V> getType()

Returns the type of value to be converted.

Specified by:

getType in interface Validation<V>

Returns:

The type of value to be converted.

getMessageTemplate

String getMessageTemplate(ValidationContext<?> context)

Returns localized error message template.

This method may return null if converter never generates MalformedValueException.

Specified by:

getMessageTemplate in interface Validation<V>

Parameters:

context - Validation context.

Returns:

Localized error message template.

appendMessageArguments

boolean appendMessageArguments(ValidationContext<?> context,
                               Map<String,Object> arguments)

Appends arguments to be substituted into the error message template.

Specified by:

appendMessageArguments in interface Validation<V>

Parameters:

context - Validation context.

arguments - Arguments to be substituted into the error message template.

Returns:

true if error message template needs to be rendered; false otherwise.

decode

<T> V decode(String value,
             ValidationContext<T> context)

Converts string representation of value into object.

The method ValidationContext.isLocalizedConvert() determines if converter should take locale into account. Locale can be obtained through the method ValidationContext.getMessageLocale().

Type Parameters:

T - The type of validated entity.

Parameters:

value - String representation of value.

context - Validation context.

Returns:

Decoded value.

Throws:

MalformedValueException - if conversion fails.

encode

<T> String encode(V value,
                  ValidationContext<T> context)

Converts value into string representation.

The method ValidationContext.isLocalizedConvert() determines if converter should take locale into account. Locale can be obtained through the method ValidationContext.getMessageLocale().

Type Parameters:

T - The type of validated entity.

Parameters:

value - Value to be encoded.

context - Validation context.

Returns:

String representation of value.