Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

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

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago
initial import of LiRK3
File size: 34.5 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>
7	Commandline (Apache Ant API)
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.apache.tools.ant.types.Commandline class">
11
12	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14	<SCRIPT type="text/javascript">
15	function windowTitle()
16	{
17	parent.document.title="Commandline (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> </TD>
36	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
37	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
38	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
39	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
40	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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	<A HREF="../../../../../org/apache/tools/ant/types/Assertions.EnabledAssertion.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>
53	<A HREF="../../../../../org/apache/tools/ant/types/Commandline.Argument.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>
56	<A HREF="Commandline.html" target="_top"><B>NO FRAMES</B></A>
57	<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: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
73	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <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">
84	org.apache.tools.ant.types</FONT>
85	<BR>
86	Class Commandline</H2>
87	<PRE>
88	java.lang.Object
89	<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.Commandline</B>
90	</PRE>
91	<DL>
92	<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable</DD>
93	</DL>
94	<HR>
95	<DL>
96	<DT>public class <B>Commandline</B><DT>extends java.lang.Object<DT>implements java.lang.Cloneable</DL>
97
98	<P>
99	Commandline objects help handling command lines specifying processes to
100	execute.
101
102	The class can be used to define a command line as nested elements or as a
103	helper to define a command line by an application.
104	<p>
105	<code>
106	<someelement><br>
107	<acommandline executable="/executable/to/run"><br>
108	<argument value="argument 1" /><br>
109	<argument line="argument_1 argument_2 argument_3" /><br>
110	<argument value="argument 4" /><br>
111	</acommandline><br>
112	</someelement><br>
113	</code>
114	The element <code>someelement</code> must provide a method
115	<code>createAcommandline</code> which returns an instance of this class.
116	<P>
117
118	<P>
119	<HR>
120
121	<P>
122	<!-- ======== NESTED CLASS SUMMARY ======== -->
123
124	<A NAME="nested_class_summary"><!-- --></A>
125	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
127	<TD COLSPAN=2><FONT SIZE="+2">
128	<B>Nested Class Summary</B></FONT></TD>
129	</TR>
130	<TR BGCOLOR="white" CLASS="TableRowColor">
131	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132	<CODE>static class</CODE></FONT></TD>
133	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.Argument.html" title="class in org.apache.tools.ant.types">Commandline.Argument</A></B></CODE>
134
135	<BR>
136	Used for nested xml command line definitions.</TD>
137	</TR>
138	<TR BGCOLOR="white" CLASS="TableRowColor">
139	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140	<CODE> class</CODE></FONT></TD>
141	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.Marker.html" title="class in org.apache.tools.ant.types">Commandline.Marker</A></B></CODE>
142
143	<BR>
144	Class to keep track of the position of an Argument.</TD>
145	</TR>
146	</TABLE>
147
148	<!-- =========== FIELD SUMMARY =========== -->
149
150	<A NAME="field_summary"><!-- --></A>
151	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
152	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
153	<TD COLSPAN=2><FONT SIZE="+2">
154	<B>Field Summary</B></FONT></TD>
155	</TR>
156	<TR BGCOLOR="white" CLASS="TableRowColor">
157	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158	<CODE>protected static java.lang.String</CODE></FONT></TD>
159	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#DISCLAIMER">DISCLAIMER</A></B></CODE>
160
161	<BR>
162	</TD>
163	</TR>
164	</TABLE>
165
166	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
167
168	<A NAME="constructor_summary"><!-- --></A>
169	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
171	<TD COLSPAN=2><FONT SIZE="+2">
172	<B>Constructor Summary</B></FONT></TD>
173	</TR>
174	<TR BGCOLOR="white" CLASS="TableRowColor">
175	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#Commandline()">Commandline</A></B>()</CODE>
176
177	<BR>
178	Create an empty command line</TD>
179	</TR>
180	<TR BGCOLOR="white" CLASS="TableRowColor">
181	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#Commandline(java.lang.String)">Commandline</A></B>(java.lang.String toProcess)</CODE>
182
183	<BR>
184	create a command line from a string</TD>
185	</TR>
186	</TABLE>
187
188	<!-- ========== METHOD SUMMARY =========== -->
189
190	<A NAME="method_summary"><!-- --></A>
191	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
192	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
193	<TD COLSPAN=2><FONT SIZE="+2">
194	<B>Method Summary</B></FONT></TD>
195	</TR>
196	<TR BGCOLOR="white" CLASS="TableRowColor">
197	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198	<CODE> void</CODE></FONT></TD>
199	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#addArguments(java.lang.String[])">addArguments</A></B>(java.lang.String[] line)</CODE>
200
201	<BR>
202	append the arguments to the existing command</TD>
203	</TR>
204	<TR BGCOLOR="white" CLASS="TableRowColor">
205	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206	<CODE> void</CODE></FONT></TD>
207	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#addArgumentsToList(java.util.ListIterator)">addArgumentsToList</A></B>(java.util.ListIterator list)</CODE>
208
209	<BR>
210	append all the arguments to the tail of a supplied list</TD>
211	</TR>
212	<TR BGCOLOR="white" CLASS="TableRowColor">
213	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214	<CODE> void</CODE></FONT></TD>
215	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#addCommandToList(java.util.ListIterator)">addCommandToList</A></B>(java.util.ListIterator list)</CODE>
216
217	<BR>
218	add the entire command, including (optional) executable to a list</TD>
219	</TR>
220	<TR BGCOLOR="white" CLASS="TableRowColor">
221	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222	<CODE> void</CODE></FONT></TD>
223	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#clear()">clear</A></B>()</CODE>
224
225	<BR>
226	Clear out the whole command line.</TD>
227	</TR>
228	<TR BGCOLOR="white" CLASS="TableRowColor">
229	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230	<CODE> void</CODE></FONT></TD>
231	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#clearArgs()">clearArgs</A></B>()</CODE>
232
233	<BR>
234	Clear out the arguments but leave the executable in place for
235	another operation.</TD>
236	</TR>
237	<TR BGCOLOR="white" CLASS="TableRowColor">
238	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239	<CODE> java.lang.Object</CODE></FONT></TD>
240	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#clone()">clone</A></B>()</CODE>
241
242	<BR>
243	Generate a deep clone of the contained object.</TD>
244	</TR>
245	<TR BGCOLOR="white" CLASS="TableRowColor">
246	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
247	<CODE> <A HREF="../../../../../org/apache/tools/ant/types/Commandline.Argument.html" title="class in org.apache.tools.ant.types">Commandline.Argument</A></CODE></FONT></TD>
248	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#createArgument()">createArgument</A></B>()</CODE>
249
250	<BR>
251	Creates an argument object.</TD>
252	</TR>
253	<TR BGCOLOR="white" CLASS="TableRowColor">
254	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
255	<CODE> <A HREF="../../../../../org/apache/tools/ant/types/Commandline.Argument.html" title="class in org.apache.tools.ant.types">Commandline.Argument</A></CODE></FONT></TD>
256	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#createArgument(boolean)">createArgument</A></B>(boolean insertAtStart)</CODE>
257
258	<BR>
259	Creates an argument object and adds it to our list of args.</TD>
260	</TR>
261	<TR BGCOLOR="white" CLASS="TableRowColor">
262	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
263	<CODE> <A HREF="../../../../../org/apache/tools/ant/types/Commandline.Marker.html" title="class in org.apache.tools.ant.types">Commandline.Marker</A></CODE></FONT></TD>
264	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#createMarker()">createMarker</A></B>()</CODE>
265
266	<BR>
267	Return a marker.</TD>
268	</TR>
269	<TR BGCOLOR="white" CLASS="TableRowColor">
270	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
271	<CODE> java.lang.String</CODE></FONT></TD>
272	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#describeArguments()">describeArguments</A></B>()</CODE>
273
274	<BR>
275	Returns a String that describes the arguments suitable for
276	verbose output before a call to
277	<code>Runtime.exec(String[])<code></TD>
278	</TR>
279	<TR BGCOLOR="white" CLASS="TableRowColor">
280	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
281	<CODE>static java.lang.String</CODE></FONT></TD>
282	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#describeArguments(org.apache.tools.ant.types.Commandline)">describeArguments</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> line)</CODE>
283
284	<BR>
285	Returns a String that describes the arguments suitable for
286	verbose output before a call to
287	<code>Runtime.exec(String[])<code></TD>
288	</TR>
289	<TR BGCOLOR="white" CLASS="TableRowColor">
290	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
291	<CODE>static java.lang.String</CODE></FONT></TD>
292	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#describeArguments(java.lang.String[])">describeArguments</A></B>(java.lang.String[] args)</CODE>
293
294	<BR>
295	Returns a String that describes the arguments suitable for
296	verbose output before a call to
297	<code>Runtime.exec(String[])<code></TD>
298	</TR>
299	<TR BGCOLOR="white" CLASS="TableRowColor">
300	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301	<CODE>protected static java.lang.String</CODE></FONT></TD>
302	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#describeArguments(java.lang.String[], int)">describeArguments</A></B>(java.lang.String[] args,
303	int offset)</CODE>
304
305	<BR>
306	Returns a String that describes the arguments suitable for
307	verbose output before a call to
308	<code>Runtime.exec(String[])<code></TD>
309	</TR>
310	<TR BGCOLOR="white" CLASS="TableRowColor">
311	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
312	<CODE> java.lang.String</CODE></FONT></TD>
313	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#describeCommand()">describeCommand</A></B>()</CODE>
314
315	<BR>
316	Returns a String that describes the command and arguments
317	suitable for verbose output before a call to
318	<code>Runtime.exec(String[])<code></TD>
319	</TR>
320	<TR BGCOLOR="white" CLASS="TableRowColor">
321	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
322	<CODE>static java.lang.String</CODE></FONT></TD>
323	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#describeCommand(org.apache.tools.ant.types.Commandline)">describeCommand</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> line)</CODE>
324
325	<BR>
326	Returns a String that describes the command and arguments
327	suitable for verbose output before a call to
328	<code>Runtime.exec(String[])<code></TD>
329	</TR>
330	<TR BGCOLOR="white" CLASS="TableRowColor">
331	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
332	<CODE>static java.lang.String</CODE></FONT></TD>
333	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#describeCommand(java.lang.String[])">describeCommand</A></B>(java.lang.String[] args)</CODE>
334
335	<BR>
336	Returns a String that describes the command and arguments
337	suitable for verbose output before a call to
338	<code>Runtime.exec(String[])<code>.</TD>
339	</TR>
340	<TR BGCOLOR="white" CLASS="TableRowColor">
341	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
342	<CODE> java.lang.String[]</CODE></FONT></TD>
343	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#getArguments()">getArguments</A></B>()</CODE>
344
345	<BR>
346	Returns all arguments defined by <code>addLine</code>,
347	<code>addValue</code> or the argument object.</TD>
348	</TR>
349	<TR BGCOLOR="white" CLASS="TableRowColor">
350	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
351	<CODE> java.lang.String[]</CODE></FONT></TD>
352	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#getCommandline()">getCommandline</A></B>()</CODE>
353
354	<BR>
355	Returns the executable and all defined arguments.</TD>
356	</TR>
357	<TR BGCOLOR="white" CLASS="TableRowColor">
358	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
359	<CODE> java.lang.String</CODE></FONT></TD>
360	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#getExecutable()">getExecutable</A></B>()</CODE>
361
362	<BR>
363	get the executable</TD>
364	</TR>
365	<TR BGCOLOR="white" CLASS="TableRowColor">
366	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
367	<CODE>static java.lang.String</CODE></FONT></TD>
368	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#quoteArgument(java.lang.String)">quoteArgument</A></B>(java.lang.String argument)</CODE>
369
370	<BR>
371	Put quotes around the given String if necessary.</TD>
372	</TR>
373	<TR BGCOLOR="white" CLASS="TableRowColor">
374	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
375	<CODE> void</CODE></FONT></TD>
376	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#setExecutable(java.lang.String)">setExecutable</A></B>(java.lang.String executable)</CODE>
377
378	<BR>
379	Sets the executable to run.</TD>
380	</TR>
381	<TR BGCOLOR="white" CLASS="TableRowColor">
382	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
383	<CODE> int</CODE></FONT></TD>
384	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#size()">size</A></B>()</CODE>
385
386	<BR>
387	size operator.</TD>
388	</TR>
389	<TR BGCOLOR="white" CLASS="TableRowColor">
390	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
391	<CODE> java.lang.String</CODE></FONT></TD>
392	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#toString()">toString</A></B>()</CODE>
393
394	<BR>
395	stringify operator returns the command line as a string</TD>
396	</TR>
397	<TR BGCOLOR="white" CLASS="TableRowColor">
398	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
399	<CODE>static java.lang.String</CODE></FONT></TD>
400	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#toString(java.lang.String[])">toString</A></B>(java.lang.String[] line)</CODE>
401
402	<BR>
403	Quotes the parts of the given array in way that makes them
404	usable as command line arguments.</TD>
405	</TR>
406	<TR BGCOLOR="white" CLASS="TableRowColor">
407	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
408	<CODE>static java.lang.String[]</CODE></FONT></TD>
409	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#translateCommandline(java.lang.String)">translateCommandline</A></B>(java.lang.String toProcess)</CODE>
410
411	<BR>
412	crack a command line</TD>
413	</TR>
414	</TABLE>
415	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
416	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
417	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
418	<TD><B>Methods inherited from class java.lang.Object</B></TD>
419	</TR>
420	<TR BGCOLOR="white" CLASS="TableRowColor">
421	<TD><CODE>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
422	</TR>
423	</TABLE>
424
425	<P>
426
427	<!-- ============ FIELD DETAIL =========== -->
428
429	<A NAME="field_detail"><!-- --></A>
430	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
431	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
432	<TD COLSPAN=1><FONT SIZE="+2">
433	<B>Field Detail</B></FONT></TD>
434	</TR>
435	</TABLE>
436
437	<A NAME="DISCLAIMER"><!-- --></A><H3>
438	DISCLAIMER</H3>
439	<PRE>
440	protected static final java.lang.String <B>DISCLAIMER</B></PRE>
441	<DL>
442	<DL>
443	</DL>
444	</DL>
445
446	<!-- ========= CONSTRUCTOR DETAIL ======== -->
447
448	<A NAME="constructor_detail"><!-- --></A>
449	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
450	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
451	<TD COLSPAN=1><FONT SIZE="+2">
452	<B>Constructor Detail</B></FONT></TD>
453	</TR>
454	</TABLE>
455
456	<A NAME="Commandline(java.lang.String)"><!-- --></A><H3>
457	Commandline</H3>
458	<PRE>
459	public <B>Commandline</B>(java.lang.String toProcess)</PRE>
460	<DL>
461	<DD>create a command line from a string
462	<P>
463	<DT><B>Parameters:</B><DD><CODE>toProcess</CODE> - the line: the first element becomes the executable, the rest
464	the arguments</DL>
465	<HR>
466
467	<A NAME="Commandline()"><!-- --></A><H3>
468	Commandline</H3>
469	<PRE>
470	public <B>Commandline</B>()</PRE>
471	<DL>
472	<DD>Create an empty command line
473	<P>
474	</DL>
475
476	<!-- ============ METHOD DETAIL ========== -->
477
478	<A NAME="method_detail"><!-- --></A>
479	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
480	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
481	<TD COLSPAN=1><FONT SIZE="+2">
482	<B>Method Detail</B></FONT></TD>
483	</TR>
484	</TABLE>
485
486	<A NAME="createArgument()"><!-- --></A><H3>
487	createArgument</H3>
488	<PRE>
489	public <A HREF="../../../../../org/apache/tools/ant/types/Commandline.Argument.html" title="class in org.apache.tools.ant.types">Commandline.Argument</A> <B>createArgument</B>()</PRE>
490	<DL>
491	<DD>Creates an argument object.
492
493	<p>Each commandline object has at most one instance of the
494	argument class. This method calls
495	<code>this.createArgument(false)</code>.</p>
496	<P>
497	<DD><DL>
498	</DL>
499	</DD>
500	<DD><DL>
501
502	<DT><B>Returns:</B><DD>the argument object.<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/types/Commandline.html#createArgument(boolean)"><CODE>createArgument(boolean)</CODE></A></DL>
503	</DD>
504	</DL>
505	<HR>
506
507	<A NAME="createArgument(boolean)"><!-- --></A><H3>
508	createArgument</H3>
509	<PRE>
510	public <A HREF="../../../../../org/apache/tools/ant/types/Commandline.Argument.html" title="class in org.apache.tools.ant.types">Commandline.Argument</A> <B>createArgument</B>(boolean insertAtStart)</PRE>
511	<DL>
512	<DD>Creates an argument object and adds it to our list of args.
513
514	<p>Each commandline object has at most one instance of the
515	argument class.</p>
516	<P>
517	<DD><DL>
518	</DL>
519	</DD>
520	<DD><DL>
521	<DT><B>Parameters:</B><DD><CODE>insertAtStart</CODE> - if true, the argument is inserted at the
522	beginning of the list of args, otherwise it is appended.</DL>
523	</DD>
524	</DL>
525	<HR>
526
527	<A NAME="setExecutable(java.lang.String)"><!-- --></A><H3>
528	setExecutable</H3>
529	<PRE>
530	public void <B>setExecutable</B>(java.lang.String executable)</PRE>
531	<DL>
532	<DD>Sets the executable to run. All file separators in the string
533	are converted to the platform specific value
534	<P>
535	<DD><DL>
536	</DL>
537	</DD>
538	<DD><DL>
539	</DL>
540	</DD>
541	</DL>
542	<HR>
543
544	<A NAME="getExecutable()"><!-- --></A><H3>
545	getExecutable</H3>
546	<PRE>
547	public java.lang.String <B>getExecutable</B>()</PRE>
548	<DL>
549	<DD>get the executable
550	<P>
551	<DD><DL>
552	</DL>
553	</DD>
554	<DD><DL>
555
556	<DT><B>Returns:</B><DD>the program to run -null if not yet set</DL>
557	</DD>
558	</DL>
559	<HR>
560
561	<A NAME="addArguments(java.lang.String[])"><!-- --></A><H3>
562	addArguments</H3>
563	<PRE>
564	public void <B>addArguments</B>(java.lang.String[] line)</PRE>
565	<DL>
566	<DD>append the arguments to the existing command
567	<P>
568	<DD><DL>
569	</DL>
570	</DD>
571	<DD><DL>
572	<DT><B>Parameters:</B><DD><CODE>line</CODE> - an array of arguments to append</DL>
573	</DD>
574	</DL>
575	<HR>
576
577	<A NAME="getCommandline()"><!-- --></A><H3>
578	getCommandline</H3>
579	<PRE>
580	public java.lang.String[] <B>getCommandline</B>()</PRE>
581	<DL>
582	<DD>Returns the executable and all defined arguments.
583	<P>
584	<DD><DL>
585	</DL>
586	</DD>
587	<DD><DL>
588	</DL>
589	</DD>
590	</DL>
591	<HR>
592
593	<A NAME="addCommandToList(java.util.ListIterator)"><!-- --></A><H3>
594	addCommandToList</H3>
595	<PRE>
596	public void <B>addCommandToList</B>(java.util.ListIterator list)</PRE>
597	<DL>
598	<DD>add the entire command, including (optional) executable to a list
599	<P>
600	<DD><DL>
601	</DL>
602	</DD>
603	<DD><DL>
604	<DT><B>Parameters:</B><DD><CODE>list</CODE> - <DT><B>Since:</B></DT>
605	<DD>Ant 1.6</DD>
606	</DL>
607	</DD>
608	</DL>
609	<HR>
610
611	<A NAME="getArguments()"><!-- --></A><H3>
612	getArguments</H3>
613	<PRE>
614	public java.lang.String[] <B>getArguments</B>()</PRE>
615	<DL>
616	<DD>Returns all arguments defined by <code>addLine</code>,
617	<code>addValue</code> or the argument object.
618	<P>
619	<DD><DL>
620	</DL>
621	</DD>
622	<DD><DL>
623	</DL>
624	</DD>
625	</DL>
626	<HR>
627
628	<A NAME="addArgumentsToList(java.util.ListIterator)"><!-- --></A><H3>
629	addArgumentsToList</H3>
630	<PRE>
631	public void <B>addArgumentsToList</B>(java.util.ListIterator list)</PRE>
632	<DL>
633	<DD>append all the arguments to the tail of a supplied list
634	<P>
635	<DD><DL>
636	</DL>
637	</DD>
638	<DD><DL>
639	<DT><B>Parameters:</B><DD><CODE>list</CODE> - <DT><B>Since:</B></DT>
640	<DD>Ant 1.6</DD>
641	</DL>
642	</DD>
643	</DL>
644	<HR>
645
646	<A NAME="toString()"><!-- --></A><H3>
647	toString</H3>
648	<PRE>
649	public java.lang.String <B>toString</B>()</PRE>
650	<DL>
651	<DD>stringify operator returns the command line as a string
652	<P>
653	<DD><DL>
654	</DL>
655	</DD>
656	<DD><DL>
657
658	<DT><B>Returns:</B><DD>the command line</DL>
659	</DD>
660	</DL>
661	<HR>
662
663	<A NAME="quoteArgument(java.lang.String)"><!-- --></A><H3>
664	quoteArgument</H3>
665	<PRE>
666	public static java.lang.String <B>quoteArgument</B>(java.lang.String argument)</PRE>
667	<DL>
668	<DD>Put quotes around the given String if necessary.
669
670	<p>If the argument doesn't include spaces or quotes, return it
671	as is. If it contains double quotes, use single quotes - else
672	surround the argument by double quotes.</p>
673	<P>
674	<DD><DL>
675	</DL>
676	</DD>
677	<DD><DL>
678
679	<DT><B>Throws:</B>
680	<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the argument contains both, single
681	and double quotes.</DL>
682	</DD>
683	</DL>
684	<HR>
685
686	<A NAME="toString(java.lang.String[])"><!-- --></A><H3>
687	toString</H3>
688	<PRE>
689	public static java.lang.String <B>toString</B>(java.lang.String[] line)</PRE>
690	<DL>
691	<DD>Quotes the parts of the given array in way that makes them
692	usable as command line arguments.
693	<P>
694	<DD><DL>
695	</DL>
696	</DD>
697	<DD><DL>
698
699	<DT><B>Returns:</B><DD>empty string for null or no command, else every argument split
700	by spaces and quoted by quoting rules</DL>
701	</DD>
702	</DL>
703	<HR>
704
705	<A NAME="translateCommandline(java.lang.String)"><!-- --></A><H3>
706	translateCommandline</H3>
707	<PRE>
708	public static java.lang.String[] <B>translateCommandline</B>(java.lang.String toProcess)</PRE>
709	<DL>
710	<DD>crack a command line
711	<P>
712	<DD><DL>
713	</DL>
714	</DD>
715	<DD><DL>
716	<DT><B>Parameters:</B><DD><CODE>toProcess</CODE> - the command line to process
717	<DT><B>Returns:</B><DD>the command line broken into strings.
718	An empty or null toProcess parameter results in a zero sized array</DL>
719	</DD>
720	</DL>
721	<HR>
722
723	<A NAME="size()"><!-- --></A><H3>
724	size</H3>
725	<PRE>
726	public int <B>size</B>()</PRE>
727	<DL>
728	<DD>size operator. This actually creates the command line, so it is not
729	a zero cost operation.
730	<P>
731	<DD><DL>
732	</DL>
733	</DD>
734	<DD><DL>
735
736	<DT><B>Returns:</B><DD>number of elements in the command, including the executable</DL>
737	</DD>
738	</DL>
739	<HR>
740
741	<A NAME="clone()"><!-- --></A><H3>
742	clone</H3>
743	<PRE>
744	public java.lang.Object <B>clone</B>()</PRE>
745	<DL>
746	<DD>Generate a deep clone of the contained object.
747	<P>
748	<DD><DL>
749	</DL>
750	</DD>
751	<DD><DL>
752
753	<DT><B>Returns:</B><DD>a clone of the contained object</DL>
754	</DD>
755	</DL>
756	<HR>
757
758	<A NAME="clear()"><!-- --></A><H3>
759	clear</H3>
760	<PRE>
761	public void <B>clear</B>()</PRE>
762	<DL>
763	<DD>Clear out the whole command line.
764	<P>
765	<DD><DL>
766	</DL>
767	</DD>
768	<DD><DL>
769	</DL>
770	</DD>
771	</DL>
772	<HR>
773
774	<A NAME="clearArgs()"><!-- --></A><H3>
775	clearArgs</H3>
776	<PRE>
777	public void <B>clearArgs</B>()</PRE>
778	<DL>
779	<DD>Clear out the arguments but leave the executable in place for
780	another operation.
781	<P>
782	<DD><DL>
783	</DL>
784	</DD>
785	<DD><DL>
786	</DL>
787	</DD>
788	</DL>
789	<HR>
790
791	<A NAME="createMarker()"><!-- --></A><H3>
792	createMarker</H3>
793	<PRE>
794	public <A HREF="../../../../../org/apache/tools/ant/types/Commandline.Marker.html" title="class in org.apache.tools.ant.types">Commandline.Marker</A> <B>createMarker</B>()</PRE>
795	<DL>
796	<DD>Return a marker.
797
798	<p>This marker can be used to locate a position on the
799	commandline - to insert something for example - when all
800	parameters have been set.</p>
801	<P>
802	<DD><DL>
803	</DL>
804	</DD>
805	<DD><DL>
806	</DL>
807	</DD>
808	</DL>
809	<HR>
810
811	<A NAME="describeCommand()"><!-- --></A><H3>
812	describeCommand</H3>
813	<PRE>
814	public java.lang.String <B>describeCommand</B>()</PRE>
815	<DL>
816	<DD>Returns a String that describes the command and arguments
817	suitable for verbose output before a call to
818	<code>Runtime.exec(String[])<code>
819	<P>
820	<DD><DL>
821	</DL>
822	</DD>
823	<DD><DL>
824	<DT><B>Since:</B></DT>
825	<DD>Ant 1.5</DD>
826	</DL>
827	</DD>
828	</DL>
829	<HR>
830
831	<A NAME="describeArguments()"><!-- --></A><H3>
832	describeArguments</H3>
833	<PRE>
834	public java.lang.String <B>describeArguments</B>()</PRE>
835	<DL>
836	<DD>Returns a String that describes the arguments suitable for
837	verbose output before a call to
838	<code>Runtime.exec(String[])<code>
839	<P>
840	<DD><DL>
841	</DL>
842	</DD>
843	<DD><DL>
844	<DT><B>Since:</B></DT>
845	<DD>Ant 1.5</DD>
846	</DL>
847	</DD>
848	</DL>
849	<HR>
850
851	<A NAME="describeCommand(org.apache.tools.ant.types.Commandline)"><!-- --></A><H3>
852	describeCommand</H3>
853	<PRE>
854	public static java.lang.String <B>describeCommand</B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> line)</PRE>
855	<DL>
856	<DD>Returns a String that describes the command and arguments
857	suitable for verbose output before a call to
858	<code>Runtime.exec(String[])<code>
859	<P>
860	<DD><DL>
861	</DL>
862	</DD>
863	<DD><DL>
864	<DT><B>Since:</B></DT>
865	<DD>Ant 1.5</DD>
866	</DL>
867	</DD>
868	</DL>
869	<HR>
870
871	<A NAME="describeArguments(org.apache.tools.ant.types.Commandline)"><!-- --></A><H3>
872	describeArguments</H3>
873	<PRE>
874	public static java.lang.String <B>describeArguments</B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> line)</PRE>
875	<DL>
876	<DD>Returns a String that describes the arguments suitable for
877	verbose output before a call to
878	<code>Runtime.exec(String[])<code>
879	<P>
880	<DD><DL>
881	</DL>
882	</DD>
883	<DD><DL>
884	<DT><B>Since:</B></DT>
885	<DD>Ant 1.5</DD>
886	</DL>
887	</DD>
888	</DL>
889	<HR>
890
891	<A NAME="describeCommand(java.lang.String[])"><!-- --></A><H3>
892	describeCommand</H3>
893	<PRE>
894	public static java.lang.String <B>describeCommand</B>(java.lang.String[] args)</PRE>
895	<DL>
896	<DD>Returns a String that describes the command and arguments
897	suitable for verbose output before a call to
898	<code>Runtime.exec(String[])<code>.
899
900	<p>This method assumes that the first entry in the array is the
901	executable to run.</p>
902	<P>
903	<DD><DL>
904	</DL>
905	</DD>
906	<DD><DL>
907	<DT><B>Since:</B></DT>
908	<DD>Ant 1.5</DD>
909	</DL>
910	</DD>
911	</DL>
912	<HR>
913
914	<A NAME="describeArguments(java.lang.String[])"><!-- --></A><H3>
915	describeArguments</H3>
916	<PRE>
917	public static java.lang.String <B>describeArguments</B>(java.lang.String[] args)</PRE>
918	<DL>
919	<DD>Returns a String that describes the arguments suitable for
920	verbose output before a call to
921	<code>Runtime.exec(String[])<code>
922	<P>
923	<DD><DL>
924	</DL>
925	</DD>
926	<DD><DL>
927	<DT><B>Since:</B></DT>
928	<DD>Ant 1.5</DD>
929	</DL>
930	</DD>
931	</DL>
932	<HR>
933
934	<A NAME="describeArguments(java.lang.String[], int)"><!-- --></A><H3>
935	describeArguments</H3>
936	<PRE>
937	protected static java.lang.String <B>describeArguments</B>(java.lang.String[] args,
938	int offset)</PRE>
939	<DL>
940	<DD>Returns a String that describes the arguments suitable for
941	verbose output before a call to
942	<code>Runtime.exec(String[])<code>
943	<P>
944	<DD><DL>
945	</DL>
946	</DD>
947	<DD><DL>
948	<DT><B>Parameters:</B><DD><CODE>offset</CODE> - ignore entries before this index<DT><B>Since:</B></DT>
949	<DD>Ant 1.5</DD>
950	</DL>
951	</DD>
952	</DL>
953	<!-- ========= END OF CLASS DATA ========= -->
954	<HR>
955
956
957	<!-- ======= START OF BOTTOM NAVBAR ====== -->
958	<A NAME="navbar_bottom"><!-- --></A>
959	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
960	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
961	<TR>
962	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
963	<A NAME="navbar_bottom_firstrow"><!-- --></A>
964	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
965	<TR ALIGN="center" VALIGN="top">
966	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
967	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
968	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
969	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
970	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
971	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
972	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
973	</TR>
974	</TABLE>
975	</TD>
976	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
977	</EM>
978	</TD>
979	</TR>
980
981	<TR>
982	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
983	<A HREF="../../../../../org/apache/tools/ant/types/Assertions.EnabledAssertion.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>
984	<A HREF="../../../../../org/apache/tools/ant/types/Commandline.Argument.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
985	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
986	<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
987	<A HREF="Commandline.html" target="_top"><B>NO FRAMES</B></A>
988	<SCRIPT type="text/javascript">
989	<!--
990	if(window==top) {
991	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
992	}
993	//-->
994	</SCRIPT>
995	<NOSCRIPT>
996	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
997	</NOSCRIPT>
998
999	</FONT></TD>
1000	</TR>
1001	<TR>
1002	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1003	SUMMARY: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
1004	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1005	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
1006	</TR>
1007	</TABLE>
1008	<A NAME="skip-navbar_bottom"></A>
1009	<!-- ======== END OF BOTTOM NAVBAR ======= -->
1010
1011	<HR>
1012	Copyright Â© 2000-2007 Apache Software Foundation. All Rights Reserved.
1013	</BODY>
1014	</HTML>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: