org.soulwing.cdi.properties.spi

Interface PropertyConverter

public interface PropertyConverter

An object that converts the string representation of property value to an instance of a target type.

A property converter is configured for the Pinject extension by placing a provider configuration file in the resource directory META-INF/services of a directory or JAR file on the classpath of the extension. The name of the configuration file is:

org.soulwing.cdi.properties.spi.PropertyConverter

The file may contain one or more fully-qualified class names of classes that implement this interface.

Author:

Carl Harris

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PropertyConverter.Context A context for a property conversion.

Method Summary

Modifier and Type	Method and Description
Object	convert(String value, PropertyConverter.Context context) Converts the given string representation of a property value to an instance of the underlying type supported by this converter.
String	getName() Gets the name for this property converter.
boolean	supports(Class<?> type) Tests whether this converter supports a given type.

Method Detail

getName

String getName()

Gets the name for this property converter.

The Property qualifier allows a named converter to be specified.

Returns:

converter name (never null)

supports

boolean supports(Class<?> type)

Tests whether this converter supports a given type.

Parameters:

type - the subject type

Returns:

true if this converter can converter string representations of a property of the given type

convert

Object convert(String value,
               PropertyConverter.Context context)
        throws IllegalArgumentException

Converts the given string representation of a property value to an instance of the underlying type supported by this converter.

Parameters:

value - the value to convert

context - conversion context

Returns:

a representation of value as type T

Throws:

IllegalArgumentException - if the given value is a syntactically invalid string representation for type