KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > celtix > configuration > ConfigurationBuilder


1 package org.objectweb.celtix.configuration;
2
3
4 public interface ConfigurationBuilder {
5     String JavaDoc CONFIGURATION_BUILDER_CLASS_PROPERTY = "org.objectweb.celtix.ConfigurationBuilderClass";
6     
7     /**
8      * Returns the top level <code>Configuration</code> object with the specified namespace and
9      * identifer or null if such a configuration does not exist.
10      * @throws ConfigurationException if no configuration metadata for the specified namespace is
11      * available.
12      * @param namespaceUri the configuration namespace.
13      * @param id the configuration identifier.
14      * @return the configuration.
15      */

16     Configuration getConfiguration(String JavaDoc namespaceUri, String JavaDoc id);
17     
18     /**
19      * Returns the <code>Configuration</code> object with the specified namespace and
20      * identifer that is a child of the specified parent configuration, or null if such a
21      * configuration does not exist.
22      * @throws ConfigurationException if no configuration metadata for the specified namespace is
23      * available.
24      * @param namespaceURI the configuration namespace.
25      * @param id the configuration identifier.
26      * @param parent the parent configuration.
27      * @return the configuration.
28      */

29     Configuration getConfiguration(String JavaDoc namespaceURI, String JavaDoc id, Configuration parent);
30     
31     /**
32      * Creates a new top level <code>Configuration</code> object for the given namepace
33      * with the specified identifier.
34      * @param namespaceUri the configuration namespace.
35      * @param id the configuration identifier.
36      * @return the newly created configuration.
37      */

38     Configuration buildConfiguration(String JavaDoc namespaceUri, String JavaDoc id);
39     
40     /**
41      * Creates a new <code>Configuration</code> object for the given namepace as a child
42      * of the specified parent configuration and with the specified identifier.
43      * @paam namespaceUri the configuration namespace.
44      * @param id the configuration identifier.
45      * @param parent the parent configuration.
46      * @return the newly created configuration.
47      */

48     Configuration buildConfiguration(String JavaDoc namespaceUri, String JavaDoc id, Configuration parent);
49     
50     /**
51      * Stores the specified configuration model with the builder.
52      * @param model the configuration metadata model.
53      */

54     void addModel(ConfigurationMetadata model);
55
56     /**
57      * Stores the specified configuration model with the builder.
58      * @param resource url to the configuration metadata model.
59      */

60     void addModel(String JavaDoc resource);
61     
62     /**
63      * Returns the configuration metadata model for the given namespace or null if no such
64      * model is stored in this builder.
65      * @param namespaceURI the configuration namespace.
66      * @return the configuration metadata model.
67      */

68     ConfigurationMetadata getModel(String JavaDoc namespaceURI);
69     
70 }
71
Popular Tags