source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/types/Environment.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 13.3 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:32 NZST 2007 -->
6<TITLE>
7Environment (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.Environment class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="Environment (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="Environment.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.types</FONT>
85<BR>
86Class Environment</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.Environment</B>
90</PRE>
91<DL>
92<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/tools/ant/types/CommandlineJava.SysProperties.html" title="class in org.apache.tools.ant.types">CommandlineJava.SysProperties</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>Environment</B><DT>extends java.lang.Object</DL>
97
98<P>
99Wrapper for environment variables.
100<P>
101
102<P>
103<HR>
104
105<P>
106<!-- ======== NESTED CLASS SUMMARY ======== -->
107
108<A NAME="nested_class_summary"><!-- --></A>
109<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
110<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
111<TD COLSPAN=2><FONT SIZE="+2">
112<B>Nested Class Summary</B></FONT></TD>
113</TR>
114<TR BGCOLOR="white" CLASS="TableRowColor">
115<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
116<CODE>static&nbsp;class</CODE></FONT></TD>
117<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html" title="class in org.apache.tools.ant.types">Environment.Variable</A></B></CODE>
118
119<BR>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;representation of a single env value</TD>
121</TR>
122</TABLE>
123&nbsp;
124<!-- =========== FIELD SUMMARY =========== -->
125
126<A NAME="field_summary"><!-- --></A>
127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
129<TD COLSPAN=2><FONT SIZE="+2">
130<B>Field Summary</B></FONT></TD>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134<CODE>protected &nbsp;java.util.Vector</CODE></FONT></TD>
135<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.html#variables">variables</A></B></CODE>
136
137<BR>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;a vector of type Enviromment.Variable</TD>
139</TR>
140</TABLE>
141&nbsp;
142<!-- ======== CONSTRUCTOR SUMMARY ======== -->
143
144<A NAME="constructor_summary"><!-- --></A>
145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
147<TD COLSPAN=2><FONT SIZE="+2">
148<B>Constructor Summary</B></FONT></TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.html#Environment()">Environment</A></B>()</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;constructor</TD>
155</TR>
156</TABLE>
157&nbsp;
158<!-- ========== METHOD SUMMARY =========== -->
159
160<A NAME="method_summary"><!-- --></A>
161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
162<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
163<TD COLSPAN=2><FONT SIZE="+2">
164<B>Method Summary</B></FONT></TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>&nbsp;void</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.html#addVariable(org.apache.tools.ant.types.Environment.Variable)">addVariable</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html" title="class in org.apache.tools.ant.types">Environment.Variable</A>&nbsp;var)</CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;add a variable.</TD>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
177<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.html#getVariables()">getVariables</A></B>()</CODE>
178
179<BR>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get the variable list as an array</TD>
181</TR>
182</TABLE>
183&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
186<TD><B>Methods inherited from class java.lang.Object</B></TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
190</TR>
191</TABLE>
192&nbsp;
193<P>
194
195<!-- ============ FIELD DETAIL =========== -->
196
197<A NAME="field_detail"><!-- --></A>
198<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
199<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
200<TD COLSPAN=1><FONT SIZE="+2">
201<B>Field Detail</B></FONT></TD>
202</TR>
203</TABLE>
204
205<A NAME="variables"><!-- --></A><H3>
206variables</H3>
207<PRE>
208protected java.util.Vector <B>variables</B></PRE>
209<DL>
210<DD>a vector of type Enviromment.Variable
211<P>
212<DL>
213<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html" title="class in org.apache.tools.ant.types"><CODE>Environment.Variable</CODE></A></DL>
214</DL>
215
216<!-- ========= CONSTRUCTOR DETAIL ======== -->
217
218<A NAME="constructor_detail"><!-- --></A>
219<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
220<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
221<TD COLSPAN=1><FONT SIZE="+2">
222<B>Constructor Detail</B></FONT></TD>
223</TR>
224</TABLE>
225
226<A NAME="Environment()"><!-- --></A><H3>
227Environment</H3>
228<PRE>
229public <B>Environment</B>()</PRE>
230<DL>
231<DD>constructor
232<P>
233</DL>
234
235<!-- ============ METHOD DETAIL ========== -->
236
237<A NAME="method_detail"><!-- --></A>
238<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
239<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
240<TD COLSPAN=1><FONT SIZE="+2">
241<B>Method Detail</B></FONT></TD>
242</TR>
243</TABLE>
244
245<A NAME="addVariable(org.apache.tools.ant.types.Environment.Variable)"><!-- --></A><H3>
246addVariable</H3>
247<PRE>
248public void <B>addVariable</B>(<A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html" title="class in org.apache.tools.ant.types">Environment.Variable</A>&nbsp;var)</PRE>
249<DL>
250<DD>add a variable.
251 Validity checking is <i>not</i> performed at this point. Duplicates
252 are not caught either.
253<P>
254<DD><DL>
255<DT><B>Parameters:</B><DD><CODE>var</CODE> - new variable.</DL>
256</DD>
257</DL>
258<HR>
259
260<A NAME="getVariables()"><!-- --></A><H3>
261getVariables</H3>
262<PRE>
263public java.lang.String[] <B>getVariables</B>()
264 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
265<DL>
266<DD>get the variable list as an array
267<P>
268<DD><DL>
269
270<DT><B>Returns:</B><DD>array of key=value assignment strings
271<DT><B>Throws:</B>
272<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if any variable is misconfigured</DL>
273</DD>
274</DL>
275<!-- ========= END OF CLASS DATA ========= -->
276<HR>
277
278
279<!-- ======= START OF BOTTOM NAVBAR ====== -->
280<A NAME="navbar_bottom"><!-- --></A>
281<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
282<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
283<TR>
284<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
285<A NAME="navbar_bottom_firstrow"><!-- --></A>
286<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
287 <TR ALIGN="center" VALIGN="top">
288 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
289 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
290 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
291 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
292 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
293 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
294 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
295 </TR>
296</TABLE>
297</TD>
298<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
299</EM>
300</TD>
301</TR>
302
303<TR>
304<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
305&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/EnumeratedAttribute.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
306&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
307<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
308 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
309&nbsp;<A HREF="Environment.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
310&nbsp;<SCRIPT type="text/javascript">
311 <!--
312 if(window==top) {
313 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
314 }
315 //-->
316</SCRIPT>
317<NOSCRIPT>
318 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
319</NOSCRIPT>
320
321</FONT></TD>
322</TR>
323<TR>
324<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
325 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
326<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
327DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
328</TR>
329</TABLE>
330<A NAME="skip-navbar_bottom"></A>
331<!-- ======== END OF BOTTOM NAVBAR ======= -->
332
333<HR>
334Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
335</BODY>
336</HTML>
Note: See TracBrowser for help on using the repository browser.