org.apache.tamaya.spi

Interface PropertyConverter<T>

Type Parameters:

T - the type of the type literal

public interface PropertyConverter<T>

Interface for an property that converts a configured String into something else. This is used for implementing type conversion from a property (String) to a certain target type. Hereby the target type can be multivalued (e.g. collections) or complex if needed.

Method Summary

Methods

Modifier and Type	Method and Description
T	convert(String value, ConversionContext context) Convert the given configuration keys from its String representation into the required target type.

Method Detail

convert

T convert(String value,
        ConversionContext context)

Convert the given configuration keys from its String representation into the required target type. The context instance passed also allows to add a list of supported formats, which is very handy in case a value could not be converted. This list of supported formats can then shown to the user to give some hints how a value could be configured.

Parameters:

value - configuration key that needs to be converted

context - the ConversionContext, containing the String value and the requested configuration key.

Returns:

converted keys

See Also:

ConversionContext.addSupportedFormats(Class, String...)