1 package org.codehaus.plexus.component.configurator.converters;
2
3 /*
4 * The MIT License
5 *
6 * Copyright (c) 2004, The Codehaus
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy of
9 * this software and associated documentation files (the "Software"), to deal in
10 * the Software without restriction, including without limitation the rights to
11 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
12 * of the Software, and to permit persons to whom the Software is furnished to do
13 * so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in all
16 * copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
27 import org.codehaus.plexus.component.configurator.ComponentConfigurationException;
28 import org.codehaus.plexus.component.configurator.ConfigurationListener;
29 import org.codehaus.plexus.component.configurator.converters.lookup.ConverterLookup;
30 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
31 import org.codehaus.plexus.configuration.PlexusConfiguration;
32
33 public interface ConfigurationConverter {
34 boolean canConvert(Class type);
35
36 /**
37 * @param converterLookup Repository of available converters
38 * @param configuration {@link PlexusConfiguration}
39 * @param type the type of object to read
40 * @param baseType the type of object the the source is
41 * @param classLoader ClassLoader which should be used for loading classes
42 * @param expressionEvaluator the expression evaluator to use for expressions
43 * @return the object
44 * @throws ComponentConfigurationException in case of an error.
45 * 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
46 */
47 Object fromConfiguration(
48 ConverterLookup converterLookup,
49 PlexusConfiguration configuration,
50 Class type,
51 Class baseType,
52 ClassLoader classLoader,
53 ExpressionEvaluator expressionEvaluator)
54 throws ComponentConfigurationException;
55
56 /**
57 * @param converterLookup Repository of available converters
58 * @param configuration {@link PlexusConfiguration}
59 * @param type the type of object to read
60 * @param baseType the type of object the the source is
61 * @param classLoader ClassLoader which should be used for loading classes
62 * @param expressionEvaluator the expression evaluator to use for expressions
63 * @param listener {@link ConfigurationListener}.
64 * @return the object
65 * @throws ComponentConfigurationException in case of an error.
66 * 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
67 */
68 Object fromConfiguration(
69 ConverterLookup converterLookup,
70 PlexusConfiguration configuration,
71 Class type,
72 Class baseType,
73 ClassLoader classLoader,
74 ExpressionEvaluator expressionEvaluator,
75 ConfigurationListener listener)
76 throws ComponentConfigurationException;
77 }