org.codehaus.plexus.component.configurator.converters

Interface ConfigurationConverter

All Known Implementing Classes:

AbstractBasicConverter, AbstractConfigurationConverter, ArrayConverter, BooleanConverter, ByteConverter, CharConverter, ClassConverter, ClassRealmConverter, CollectionConverter, DateConverter, DoubleConverter, EnumConverter, FileConverter, FloatConverter, IntConverter, LongConverter, MapConverter, ObjectWithFieldsConverter, PlexusConfigurationConverter, PropertiesConverter, ShortConverter, StringBufferConverter, StringConverter, UriConverter, UrlConverter

public interface ConfigurationConverter

Method Summary

Modifier and Type	Method and Description
boolean	canConvert(Class type)
Object	fromConfiguration(ConverterLookup converterLookup, PlexusConfiguration configuration, Class type, Class baseType, ClassLoader classLoader, ExpressionEvaluator expressionEvaluator)
Object	fromConfiguration(ConverterLookup converterLookup, PlexusConfiguration configuration, Class type, Class baseType, ClassLoader classLoader, ExpressionEvaluator expressionEvaluator, ConfigurationListener listener)

Method Detail

canConvert

boolean canConvert(Class type)

fromConfiguration

Object fromConfiguration(ConverterLookup converterLookup,
                         PlexusConfiguration configuration,
                         Class type,
                         Class baseType,
                         ClassLoader classLoader,
                         ExpressionEvaluator expressionEvaluator)
                  throws ComponentConfigurationException

Parameters:

converterLookup - Repository of available converters

configuration - PlexusConfiguration

type - the type of object to read

baseType - the type of object the the source is

classLoader - ClassLoader which should be used for loading classes

expressionEvaluator - the expression evaluator to use for expressions

Returns:

the object

Throws:

ComponentConfigurationException - in case of an error. TODO: a better way, instead of baseType, would be to pass in a factory for new classes that could be based from the given package

fromConfiguration

Object fromConfiguration(ConverterLookup converterLookup,
                         PlexusConfiguration configuration,
                         Class type,
                         Class baseType,
                         ClassLoader classLoader,
                         ExpressionEvaluator expressionEvaluator,
                         ConfigurationListener listener)
                  throws ComponentConfigurationException

Parameters:

converterLookup - Repository of available converters

configuration - PlexusConfiguration

type - the type of object to read

baseType - the type of object the the source is

classLoader - ClassLoader which should be used for loading classes

expressionEvaluator - the expression evaluator to use for expressions

listener - ConfigurationListener.

Returns:

the object

Throws:

ComponentConfigurationException - in case of an error. TODO: a better way, instead of baseType, would be to pass in a factory for new classes that could be based from the given package