KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > inversoft > config > component > ComponentConfigBuilder


1 /*
2  * Copyright (c) 2003, Inversoft
3  *
4  * This software is distribuable under the GNU Lesser General Public License.
5  * For more information visit gnu.org.
6  */
7 package com.inversoft.config.component;
8
9
10 /**
11  * <p>
12  * This interface is <em>NOT</em> used in the configuration
13  * system. This interface is provided as a common interface
14  * for supporting the parsing and building of configuration
15  * at the element level.
16  * </p>
17  *
18  * <p>
19  * The Inversoft configuration system provides a means of
20  * parsing and building based on configuration files. These
21  * are handled in a common fashion. However, it does not
22  * provide a method for handling the contents of a single
23  * file. This was done because the configuration stored in
24  * each file may have very different requirements.
25  * </p>
26  *
27  * <p>
28  * This interface is simply a good suggestion for implementors
29  * to follow when creating the configuration system for a
30  * component. It has been changed recently to NOT include a
31  * method for the actual building. It seemed much simpler and
32  * cleaner to have the individual components provide a base
33  * abstract implementation of this interface that specifies
34  * the actual build method to follow. This was done shortly
35  * after I noticed that every single configuration package I
36  * built, except one, did not fit into a common method.
37  * </p>
38  *
39  * @author Brian Pontarelli
40  * @since 2.0
41  * @version 2.0
42  */
43 public interface ComponentConfigBuilder {
44
45     /**
46      * Gets the {@link ComponentConfigBuilderRegistry ComponentConfigBuilderRegistry}
47      * that was set into this ComponentConfigBuilder.
48      *
49      * @return The ComponentConfigBuilderRegistry or null if it was never set
50      */
51     ComponentConfigBuilderRegistry getRegistry();
52
53     /**
54      * Sets the {@link ComponentConfigBuilderRegistry ComponentConfigBuilderRegistry}
55      * into this ComponentConfigBuilder so that it can be used to lookup other
56      * ComponentConfigBuilder that may be used during the build process.
57      *
58      * @param registry The ComponentConfigBuilderRegistry
59      */
60     void setRegistry(ComponentConfigBuilderRegistry registry);
61 }
Popular Tags