|
1 <?xml version="1.0" encoding="ascii"?> |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "DTD/xhtml1-transitional.dtd"> |
|
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
5 <head> |
|
6 <title>configuration</title> |
|
7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
|
8 <script type="text/javascript" src="epydoc.js"></script> |
|
9 </head> |
|
10 |
|
11 <body bgcolor="white" text="black" link="blue" vlink="#204080" |
|
12 alink="#204080"> |
|
13 <!-- ==================== NAVIGATION BAR ==================== --> |
|
14 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
15 bgcolor="#a0c0ff" cellspacing="0"> |
|
16 <tr valign="middle"> |
|
17 |
|
18 <!-- Tree link --> |
|
19 <th> <a |
|
20 href="module-tree.html">Trees</a> </th> |
|
21 |
|
22 <!-- Index link --> |
|
23 <th> <a |
|
24 href="identifier-index.html">Indices</a> </th> |
|
25 |
|
26 <!-- Help link --> |
|
27 <th> <a |
|
28 href="help.html">Help</a> </th> |
|
29 |
|
30 <th class="navbar" width="100%"></th> |
|
31 </tr> |
|
32 </table> |
|
33 <table width="100%" cellpadding="0" cellspacing="0"> |
|
34 <tr valign="top"> |
|
35 <td width="100%"> |
|
36 <span class="breadcrumbs"> |
|
37 Module configuration |
|
38 </span> |
|
39 </td> |
|
40 <td> |
|
41 <table cellpadding="0" cellspacing="0"> |
|
42 <!-- hide/show private --> |
|
43 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
|
44 onclick="toggle_private();">hide private</a>]</span></td></tr> |
|
45 <tr><td align="right"><span class="options" |
|
46 >[<a href="frames.html" target="_top">frames</a |
|
47 >] | <a href="configuration-module.html" |
|
48 target="_top">no frames</a>]</span></td></tr> |
|
49 </table> |
|
50 </td> |
|
51 </tr> |
|
52 </table> |
|
53 <!-- ==================== MODULE DESCRIPTION ==================== --> |
|
54 <h1 class="epydoc">Module configuration</h1><span class="codelink"><a href="configuration-pysrc.html">source code</a></span><br /><br /> |
|
55 <p>Defines an interface for accessing configurations, typically for SW builds.</p> |
|
56 <p>This interface is generally based on the Jakarta Commons Configuration API. A |
|
57 configuration is a collection of properties. Builders create Configuration |
|
58 objects from various source inputs.</p><br /><br /> |
|
59 |
|
60 <!-- ==================== CLASSES ==================== --> |
|
61 <a name="section-Classes"></a> |
|
62 <table class="summary" border="1" cellpadding="3" |
|
63 cellspacing="0" width="100%" bgcolor="white"> |
|
64 <tr bgcolor="#70b0f0" class="table-header"> |
|
65 <td colspan="2" class="table-header"> |
|
66 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
67 <tr valign="top"> |
|
68 <td align="left"><span class="table-header">Classes</span></td> |
|
69 <td align="right" valign="top" |
|
70 ><span class="options">[<a href="#section-Classes" |
|
71 class="privatelink" onclick="toggle_private();" |
|
72 >hide private</a>]</span></td> |
|
73 </tr> |
|
74 </table> |
|
75 </td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td width="15%" align="right" valign="top" class="summary"> |
|
79 <span class="summary-type"> </span> |
|
80 </td><td class="summary"> |
|
81 <a href="configuration.Configuration-class.html" class="summary-name">Configuration</a><br /> |
|
82 Base Configuration objects. |
|
83 </td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td width="15%" align="right" valign="top" class="summary"> |
|
87 <span class="summary-type"> </span> |
|
88 </td><td class="summary"> |
|
89 <a href="configuration.PropertiesConfiguration-class.html" class="summary-name">PropertiesConfiguration</a><br /> |
|
90 A Configuration that parses a plain text properties file. |
|
91 </td> |
|
92 </tr> |
|
93 <tr> |
|
94 <td width="15%" align="right" valign="top" class="summary"> |
|
95 <span class="summary-type"> </span> |
|
96 </td><td class="summary"> |
|
97 <a href="configuration.NestedConfiguration-class.html" class="summary-name">NestedConfiguration</a> |
|
98 </td> |
|
99 </tr> |
|
100 <tr> |
|
101 <td width="15%" align="right" valign="top" class="summary"> |
|
102 <span class="summary-type"> </span> |
|
103 </td><td class="summary"> |
|
104 <a href="configuration.Specification-class.html" class="summary-name">Specification</a><br /> |
|
105 Deprecated. |
|
106 </td> |
|
107 </tr> |
|
108 <tr> |
|
109 <td width="15%" align="right" valign="top" class="summary"> |
|
110 <span class="summary-type"> </span> |
|
111 </td><td class="summary"> |
|
112 <a href="configuration.ConfigurationSet-class.html" class="summary-name">ConfigurationSet</a><br /> |
|
113 A ConfigurationSet represents a set of configurations. |
|
114 </td> |
|
115 </tr> |
|
116 <tr> |
|
117 <td width="15%" align="right" valign="top" class="summary"> |
|
118 <span class="summary-type"> </span> |
|
119 </td><td class="summary"> |
|
120 <a href="configuration.ConfigurationBuilder-class.html" class="summary-name">ConfigurationBuilder</a><br /> |
|
121 Base class for builders that can create Configuration objects. |
|
122 </td> |
|
123 </tr> |
|
124 <tr> |
|
125 <td width="15%" align="right" valign="top" class="summary"> |
|
126 <span class="summary-type"> </span> |
|
127 </td><td class="summary"> |
|
128 <a href="configuration.NestedConfigurationBuilder-class.html" class="summary-name">NestedConfigurationBuilder</a><br /> |
|
129 Builder for building Configuration objects from nested configurations. |
|
130 </td> |
|
131 </tr> |
|
132 <tr> |
|
133 <td width="15%" align="right" valign="top" class="summary"> |
|
134 <span class="summary-type"> </span> |
|
135 </td><td class="summary"> |
|
136 <a href="configuration.HierarchicalConfiguration-class.html" class="summary-name">HierarchicalConfiguration</a><br /> |
|
137 Represents hierarchical configurations such as XML documents. |
|
138 </td> |
|
139 </tr> |
|
140 <tr class="private"> |
|
141 <td width="15%" align="right" valign="top" class="summary"> |
|
142 <span class="summary-type"> </span> |
|
143 </td><td class="summary"> |
|
144 <a href="configuration._Key-class.html" class="summary-name">_Key</a><br /> |
|
145 A hierarchical configuration key. |
|
146 </td> |
|
147 </tr> |
|
148 <tr> |
|
149 <td width="15%" align="right" valign="top" class="summary"> |
|
150 <span class="summary-type"> </span> |
|
151 </td><td class="summary"> |
|
152 <a href="configuration.XMLConfiguration-class.html" class="summary-name">XMLConfiguration</a><br /> |
|
153 A XML-based hierarchical configuration. |
|
154 </td> |
|
155 </tr> |
|
156 </table> |
|
157 <!-- ==================== VARIABLES ==================== --> |
|
158 <a name="section-Variables"></a> |
|
159 <table class="summary" border="1" cellpadding="3" |
|
160 cellspacing="0" width="100%" bgcolor="white"> |
|
161 <tr bgcolor="#70b0f0" class="table-header"> |
|
162 <td colspan="2" class="table-header"> |
|
163 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
164 <tr valign="top"> |
|
165 <td align="left"><span class="table-header">Variables</span></td> |
|
166 <td align="right" valign="top" |
|
167 ><span class="options">[<a href="#section-Variables" |
|
168 class="privatelink" onclick="toggle_private();" |
|
169 >hide private</a>]</span></td> |
|
170 </tr> |
|
171 </table> |
|
172 </td> |
|
173 </tr> |
|
174 <tr class="private"> |
|
175 <td width="15%" align="right" valign="top" class="summary"> |
|
176 <span class="summary-type"> </span> |
|
177 </td><td class="summary"> |
|
178 <a name="_logger"></a><span class="summary-name">_logger</span> = <code title="logging.getLogger('configuration')">logging.getLogger('configuration')</code> |
|
179 </td> |
|
180 </tr> |
|
181 </table> |
|
182 <!-- ==================== NAVIGATION BAR ==================== --> |
|
183 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
184 bgcolor="#a0c0ff" cellspacing="0"> |
|
185 <tr valign="middle"> |
|
186 |
|
187 <!-- Tree link --> |
|
188 <th> <a |
|
189 href="module-tree.html">Trees</a> </th> |
|
190 |
|
191 <!-- Index link --> |
|
192 <th> <a |
|
193 href="identifier-index.html">Indices</a> </th> |
|
194 |
|
195 <!-- Help link --> |
|
196 <th> <a |
|
197 href="help.html">Help</a> </th> |
|
198 |
|
199 <th class="navbar" width="100%"></th> |
|
200 </tr> |
|
201 </table> |
|
202 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
203 <tr> |
|
204 <td align="left" class="footer"> |
|
205 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009 |
|
206 </td> |
|
207 <td align="right" class="footer"> |
|
208 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
209 </td> |
|
210 </tr> |
|
211 </table> |
|
212 |
|
213 <script type="text/javascript"> |
|
214 <!-- |
|
215 // Private objects are initially displayed (because if |
|
216 // javascript is turned off then we want them to be |
|
217 // visible); but by default, we want to hide them. So hide |
|
218 // them unless we have a cookie that says to show them. |
|
219 checkCookie() |
|
220 // --> |
|
221 </script> |
|
222 |
|
223 </body> |
|
224 </html> |