View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
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} 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 1208781 2011-11-30 21:11:02Z oheger $
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} object.
41       *
42       * @return the configuration
43       * @throws ConfigurationException if an error occurs
44       */
45      Configuration getConfiguration() throws ConfigurationException;
46  }