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 package org.apache.commons.configuration2.builder.combined;
18
19 import org.apache.commons.configuration2.Configuration;
20 import org.apache.commons.configuration2.builder.ConfigurationBuilder;
21 import org.apache.commons.configuration2.ex.ConfigurationException;
22
23 /**
24 * <p>
25 * An interface for creating builders for configuration sources of a {@link CombinedConfigurationBuilder}.
26 * </p>
27 * <p>
28 * When processing its definition file {@code CombinedConfigurationBuilder} scans for tags declaring configuration
29 * sources and maps them to implementations of this interface. The instances are then used to obtain builder objects to
30 * create the corresponding configuration sources. Parameters of the builders are provided as
31 * {@link ConfigurationDeclaration} objects.
32 * </p>
33 *
34 * @since 2.0
35 */
36 public interface ConfigurationBuilderProvider {
37 /**
38 * Gets the builder for the configuration source managed by this provider. This method is called during processing of
39 * the combined configuration definition file.
40 *
41 * @param decl the bean declaration with initialization parameters for the configuration builder
42 * @return the {@code ConfigurationBuilder} object created by this provider
43 * @throws ConfigurationException if an error occurs
44 */
45 ConfigurationBuilder<? extends Configuration> getConfigurationBuilder(ConfigurationDeclaration decl) throws ConfigurationException;
46 }