1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 package org.apache.commons.configuration;
19
20 /***
21 * <p>
22 * Definition of an interface for objects that can create a configuration.
23 * </p>
24 * <p>
25 * This interface defines an abstract way of creating a
26 * <code>Configuration</code> object. It does not assume any specific way of
27 * how this is done; this is completely in the responsibility of an
28 * implementation class. There is just a single method that returns the
29 * configuration constructed by this builder.
30 * </p>
31 *
32 * @author <a href="http://commons.apache.org/configuration/team-list.html">Commons Configuration team</a>
33 * @version $Id: ConfigurationBuilder.java 719319 2008-11-20 18:33:04Z rgoers $
34 */
35 public interface ConfigurationBuilder
36 {
37 /***
38 * Returns the configuration provided by this builder. An implementation has
39 * to perform all necessary steps for creating and initializing a
40 * <code>Configuration</code> object.
41 *
42 * @return the configuration
43 * @throws ConfigurationException if an error occurs
44 */
45 Configuration getConfiguration() throws ConfigurationException;
46 }