source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/types/Environment.Variable.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 15.2 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.Variable (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.Environment.Variable 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.Variable (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/Environment.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/FileList.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.Variable.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;NESTED&nbsp;|&nbsp;FIELD&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;FIELD&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.Variable</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.Environment.Variable</B>
90</PRE>
91<DL>
92<DT><B>Enclosing class:</B><DD><A HREF="../../../../../org/apache/tools/ant/types/Environment.html" title="class in org.apache.tools.ant.types">Environment</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public static class <B>Environment.Variable</B><DT>extends java.lang.Object</DL>
97
98<P>
99representation of a single env value
100<P>
101
102<P>
103<HR>
104
105<P>
106<!-- ======== NESTED CLASS SUMMARY ======== -->
107
108
109<!-- =========== FIELD SUMMARY =========== -->
110
111
112<!-- ======== CONSTRUCTOR SUMMARY ======== -->
113
114<A NAME="constructor_summary"><!-- --></A>
115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117<TD COLSPAN=2><FONT SIZE="+2">
118<B>Constructor Summary</B></FONT></TD>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html#Environment.Variable()">Environment.Variable</A></B>()</CODE>
122
123<BR>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for variable</TD>
125</TR>
126</TABLE>
127&nbsp;
128<!-- ========== METHOD SUMMARY =========== -->
129
130<A NAME="method_summary"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
133<TD COLSPAN=2><FONT SIZE="+2">
134<B>Method Summary</B></FONT></TD>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
139<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html#getContent()">getContent</A></B>()</CODE>
140
141<BR>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get the assigment string
143 This is not ready for insertion into a property file without following
144 the escaping rules of the properties class.</TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html#getKey()">getKey</A></B>()</CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;key accessor</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html#getValue()">getValue</A></B>()</CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value accessor</TD>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164<CODE>&nbsp;void</CODE></FONT></TD>
165<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html#setFile(java.io.File)">setFile</A></B>(java.io.File&nbsp;file)</CODE>
166
167<BR>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get the absolute path of a file and assign it to the value</TD>
169</TR>
170<TR BGCOLOR="white" CLASS="TableRowColor">
171<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172<CODE>&nbsp;void</CODE></FONT></TD>
173<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html#setKey(java.lang.String)">setKey</A></B>(java.lang.String&nbsp;key)</CODE>
174
175<BR>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the key</TD>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180<CODE>&nbsp;void</CODE></FONT></TD>
181<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html#setPath(org.apache.tools.ant.types.Path)">setPath</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;path)</CODE>
182
183<BR>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;stringify path and assign to the value.</TD>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188<CODE>&nbsp;void</CODE></FONT></TD>
189<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html#setValue(java.lang.String)">setValue</A></B>(java.lang.String&nbsp;value)</CODE>
190
191<BR>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the value</TD>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196<CODE>&nbsp;void</CODE></FONT></TD>
197<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html#validate()">validate</A></B>()</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;checks whether all required attributes have been specified.</TD>
201</TR>
202</TABLE>
203&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
204<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
205<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
206<TD><B>Methods inherited from class java.lang.Object</B></TD>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
210</TR>
211</TABLE>
212&nbsp;
213<P>
214
215<!-- ============ FIELD DETAIL =========== -->
216
217
218<!-- ========= CONSTRUCTOR DETAIL ======== -->
219
220<A NAME="constructor_detail"><!-- --></A>
221<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
222<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
223<TD COLSPAN=1><FONT SIZE="+2">
224<B>Constructor Detail</B></FONT></TD>
225</TR>
226</TABLE>
227
228<A NAME="Environment.Variable()"><!-- --></A><H3>
229Environment.Variable</H3>
230<PRE>
231public <B>Environment.Variable</B>()</PRE>
232<DL>
233<DD>Constructor for variable
234<P>
235</DL>
236
237<!-- ============ METHOD DETAIL ========== -->
238
239<A NAME="method_detail"><!-- --></A>
240<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
241<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
242<TD COLSPAN=1><FONT SIZE="+2">
243<B>Method Detail</B></FONT></TD>
244</TR>
245</TABLE>
246
247<A NAME="setKey(java.lang.String)"><!-- --></A><H3>
248setKey</H3>
249<PRE>
250public void <B>setKey</B>(java.lang.String&nbsp;key)</PRE>
251<DL>
252<DD>set the key
253<P>
254<DD><DL>
255<DT><B>Parameters:</B><DD><CODE>key</CODE> - string</DL>
256</DD>
257</DL>
258<HR>
259
260<A NAME="setValue(java.lang.String)"><!-- --></A><H3>
261setValue</H3>
262<PRE>
263public void <B>setValue</B>(java.lang.String&nbsp;value)</PRE>
264<DL>
265<DD>set the value
266<P>
267<DD><DL>
268<DT><B>Parameters:</B><DD><CODE>value</CODE> - string value</DL>
269</DD>
270</DL>
271<HR>
272
273<A NAME="getKey()"><!-- --></A><H3>
274getKey</H3>
275<PRE>
276public java.lang.String <B>getKey</B>()</PRE>
277<DL>
278<DD>key accessor
279<P>
280<DD><DL>
281
282<DT><B>Returns:</B><DD>key</DL>
283</DD>
284</DL>
285<HR>
286
287<A NAME="getValue()"><!-- --></A><H3>
288getValue</H3>
289<PRE>
290public java.lang.String <B>getValue</B>()</PRE>
291<DL>
292<DD>value accessor
293<P>
294<DD><DL>
295
296<DT><B>Returns:</B><DD>value</DL>
297</DD>
298</DL>
299<HR>
300
301<A NAME="setPath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
302setPath</H3>
303<PRE>
304public void <B>setPath</B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;path)</PRE>
305<DL>
306<DD>stringify path and assign to the value.
307 The value will contain all path elements separated by the appropriate
308 separator
309<P>
310<DD><DL>
311<DT><B>Parameters:</B><DD><CODE>path</CODE> - path</DL>
312</DD>
313</DL>
314<HR>
315
316<A NAME="setFile(java.io.File)"><!-- --></A><H3>
317setFile</H3>
318<PRE>
319public void <B>setFile</B>(java.io.File&nbsp;file)</PRE>
320<DL>
321<DD>get the absolute path of a file and assign it to the value
322<P>
323<DD><DL>
324<DT><B>Parameters:</B><DD><CODE>file</CODE> - file to use as the value</DL>
325</DD>
326</DL>
327<HR>
328
329<A NAME="getContent()"><!-- --></A><H3>
330getContent</H3>
331<PRE>
332public java.lang.String <B>getContent</B>()
333 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
334<DL>
335<DD>get the assigment string
336 This is not ready for insertion into a property file without following
337 the escaping rules of the properties class.
338<P>
339<DD><DL>
340
341<DT><B>Returns:</B><DD>a string of the form key=value.
342<DT><B>Throws:</B>
343<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if key or value are unassigned</DL>
344</DD>
345</DL>
346<HR>
347
348<A NAME="validate()"><!-- --></A><H3>
349validate</H3>
350<PRE>
351public void <B>validate</B>()</PRE>
352<DL>
353<DD>checks whether all required attributes have been specified.
354<P>
355<DD><DL>
356
357<DT><B>Throws:</B>
358<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if key or value are unassigned</DL>
359</DD>
360</DL>
361<!-- ========= END OF CLASS DATA ========= -->
362<HR>
363
364
365<!-- ======= START OF BOTTOM NAVBAR ====== -->
366<A NAME="navbar_bottom"><!-- --></A>
367<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
368<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
369<TR>
370<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
371<A NAME="navbar_bottom_firstrow"><!-- --></A>
372<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
373 <TR ALIGN="center" VALIGN="top">
374 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
375 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
376 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
377 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
378 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
379 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
380 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
381 </TR>
382</TABLE>
383</TD>
384<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
385</EM>
386</TD>
387</TR>
388
389<TR>
390<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
391&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Environment.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
392&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/FileList.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
393<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
394 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
395&nbsp;<A HREF="Environment.Variable.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
396&nbsp;<SCRIPT type="text/javascript">
397 <!--
398 if(window==top) {
399 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
400 }
401 //-->
402</SCRIPT>
403<NOSCRIPT>
404 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
405</NOSCRIPT>
406
407</FONT></TD>
408</TR>
409<TR>
410<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
411 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
412<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
413DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
414</TR>
415</TABLE>
416<A NAME="skip-navbar_bottom"></A>
417<!-- ======== END OF BOTTOM NAVBAR ======= -->
418
419<HR>
420Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
421</BODY>
422</HTML>
Note: See TracBrowser for help on using the repository browser.