View Javadoc
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  
34  public interface ConfigurationConverter
35  {
36      boolean canConvert( Class type );
37  
38      /**
39       * @param converterLookup Repository of available converters
40       * @param configuration
41       * @param type the type of object to read
42       * @param baseType the type of object the the source is
43       * @param classLoader ClassLoader which should be used for loading classes
44       * @param expressionEvaluator the expression evaluator to use for expressions
45       * @return the object
46       * @throws ComponentConfigurationException
47       * @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
48       */
49      Object fromConfiguration( ConverterLookup converterLookup, PlexusConfiguration configuration, Class type,
50                                Class baseType, ClassLoader classLoader, ExpressionEvaluator expressionEvaluator )
51          throws ComponentConfigurationException;
52  
53      /**
54       * @param converterLookup Repository of available converters
55       * @param configuration
56       * @param type the type of object to read
57       * @param baseType the type of object the the source is
58       * @param classLoader ClassLoader which should be used for loading classes
59       * @param expressionEvaluator the expression evaluator to use for expressions
60       * @return the object
61       * @throws ComponentConfigurationException
62       * @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
63       */
64      Object fromConfiguration( ConverterLookup converterLookup, PlexusConfiguration configuration, Class type,
65                                Class baseType, ClassLoader classLoader, ExpressionEvaluator expressionEvaluator,
66                                ConfigurationListener listener )
67          throws ComponentConfigurationException;
68  }