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/Target.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago
initial import of LiRK3
File size: 31.6 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:15 NZST 2007 -->
6	<TITLE>
7	Target (Apache Ant API)
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.apache.tools.ant.Target 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="Target (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/RuntimeConfigurable.html" title="class in org.apache.tools.ant"><B>PREV CLASS</B></A>
53	<A HREF="../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant"><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="Target.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: NESTED \| FIELD \| <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: FIELD \| <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</FONT>
85	<BR>
86	Class Target</H2>
87	<PRE>
88	java.lang.Object
89	<IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.Target</B>
90	</PRE>
91	<DL>
92	<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/tools/ant/TaskContainer.html" title="interface in org.apache.tools.ant">TaskContainer</A></DD>
93	</DL>
94	<HR>
95	<DL>
96	<DT>public class <B>Target</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/apache/tools/ant/TaskContainer.html" title="interface in org.apache.tools.ant">TaskContainer</A></DL>
97
98	<P>
99	Class to implement a target object with required parameters.
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/Target.html#Target()">Target</A></B>()</CODE>
122
123	<BR>
124	Sole constructor.</TD>
125	</TR>
126	</TABLE>
127
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> void</CODE></FONT></TD>
139	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#addDataType(org.apache.tools.ant.RuntimeConfigurable)">addDataType</A></B>(<A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html" title="class in org.apache.tools.ant">RuntimeConfigurable</A> r)</CODE>
140
141	<BR>
142	Adds the wrapper for a data type element to this target.</TD>
143	</TR>
144	<TR BGCOLOR="white" CLASS="TableRowColor">
145	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146	<CODE> void</CODE></FONT></TD>
147	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#addDependency(java.lang.String)">addDependency</A></B>(java.lang.String dependency)</CODE>
148
149	<BR>
150	Adds a dependency to this target.</TD>
151	</TR>
152	<TR BGCOLOR="white" CLASS="TableRowColor">
153	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154	<CODE> void</CODE></FONT></TD>
155	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#addTask(org.apache.tools.ant.Task)">addTask</A></B>(<A HREF="../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> task)</CODE>
156
157	<BR>
158	Adds a task to this target.</TD>
159	</TR>
160	<TR BGCOLOR="white" CLASS="TableRowColor">
161	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162	<CODE> boolean</CODE></FONT></TD>
163	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#dependsOn(java.lang.String)">dependsOn</A></B>(java.lang.String other)</CODE>
164
165	<BR>
166	Does this target depend on the named target?</TD>
167	</TR>
168	<TR BGCOLOR="white" CLASS="TableRowColor">
169	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170	<CODE> void</CODE></FONT></TD>
171	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#execute()">execute</A></B>()</CODE>
172
173	<BR>
174	Executes the target if the "if" and "unless" conditions are
175	satisfied.</TD>
176	</TR>
177	<TR BGCOLOR="white" CLASS="TableRowColor">
178	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179	<CODE> java.lang.String</CODE></FONT></TD>
180	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#getAddress()">getAddress</A></B>()</CODE>
181
182	<BR>
183	Returns the address of this target.</TD>
184	</TR>
185	<TR BGCOLOR="white" CLASS="TableRowColor">
186	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187	<CODE> java.util.Enumeration</CODE></FONT></TD>
188	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#getDependencies()">getDependencies</A></B>()</CODE>
189
190	<BR>
191	Returns an enumeration of the dependencies of this target.</TD>
192	</TR>
193	<TR BGCOLOR="white" CLASS="TableRowColor">
194	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195	<CODE> java.lang.String</CODE></FONT></TD>
196	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#getDescription()">getDescription</A></B>()</CODE>
197
198	<BR>
199	Returns the description of this target.</TD>
200	</TR>
201	<TR BGCOLOR="white" CLASS="TableRowColor">
202	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203	<CODE> java.lang.String</CODE></FONT></TD>
204	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#getIf()">getIf</A></B>()</CODE>
205
206	<BR>
207	Returns the "if" property condition of this target.</TD>
208	</TR>
209	<TR BGCOLOR="white" CLASS="TableRowColor">
210	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211	<CODE> <A HREF="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</A></CODE></FONT></TD>
212	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#getLocation()">getLocation</A></B>()</CODE>
213
214	<BR>
215	Get the location of this target's definition.</TD>
216	</TR>
217	<TR BGCOLOR="white" CLASS="TableRowColor">
218	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219	<CODE> java.lang.String</CODE></FONT></TD>
220	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#getName()">getName</A></B>()</CODE>
221
222	<BR>
223	Returns the name of this target.</TD>
224	</TR>
225	<TR BGCOLOR="white" CLASS="TableRowColor">
226	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227	<CODE> int</CODE></FONT></TD>
228	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#getNextSubAddress()">getNextSubAddress</A></B>()</CODE>
229
230	<BR>
231	</TD>
232	</TR>
233	<TR BGCOLOR="white" CLASS="TableRowColor">
234	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235	<CODE> <A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A></CODE></FONT></TD>
236	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#getProject()">getProject</A></B>()</CODE>
237
238	<BR>
239	Returns the project this target belongs to.</TD>
240	</TR>
241	<TR BGCOLOR="white" CLASS="TableRowColor">
242	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243	<CODE> <A HREF="../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A>[]</CODE></FONT></TD>
244	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#getTasks()">getTasks</A></B>()</CODE>
245
246	<BR>
247	Returns the current set of tasks to be executed by this target.</TD>
248	</TR>
249	<TR BGCOLOR="white" CLASS="TableRowColor">
250	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251	<CODE> java.lang.String</CODE></FONT></TD>
252	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#getUnless()">getUnless</A></B>()</CODE>
253
254	<BR>
255	Returns the "unless" property condition of this target.</TD>
256	</TR>
257	<TR BGCOLOR="white" CLASS="TableRowColor">
258	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
259	<CODE> void</CODE></FONT></TD>
260	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#incrementNextSubAddress()">incrementNextSubAddress</A></B>()</CODE>
261
262	<BR>
263	</TD>
264	</TR>
265	<TR BGCOLOR="white" CLASS="TableRowColor">
266	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267	<CODE> void</CODE></FONT></TD>
268	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#performTasks()">performTasks</A></B>()</CODE>
269
270	<BR>
271	Performs the tasks within this target (if the conditions are met),
272	firing target started/target finished messages around a call to
273	execute.</TD>
274	</TR>
275	<TR BGCOLOR="white" CLASS="TableRowColor">
276	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
277	<CODE> void</CODE></FONT></TD>
278	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#setAddress(java.lang.String)">setAddress</A></B>(java.lang.String address)</CODE>
279
280	<BR>
281	Sets the address of this target.</TD>
282	</TR>
283	<TR BGCOLOR="white" CLASS="TableRowColor">
284	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285	<CODE> void</CODE></FONT></TD>
286	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#setDepends(java.lang.String)">setDepends</A></B>(java.lang.String depS)</CODE>
287
288	<BR>
289	Sets the list of targets this target is dependent on.</TD>
290	</TR>
291	<TR BGCOLOR="white" CLASS="TableRowColor">
292	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293	<CODE> void</CODE></FONT></TD>
294	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String description)</CODE>
295
296	<BR>
297	Sets the description of this target.</TD>
298	</TR>
299	<TR BGCOLOR="white" CLASS="TableRowColor">
300	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301	<CODE> void</CODE></FONT></TD>
302	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#setIf(java.lang.String)">setIf</A></B>(java.lang.String property)</CODE>
303
304	<BR>
305	Sets the "if" condition to test on execution.</TD>
306	</TR>
307	<TR BGCOLOR="white" CLASS="TableRowColor">
308	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
309	<CODE> void</CODE></FONT></TD>
310	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#setLocation(org.apache.tools.ant.Location)">setLocation</A></B>(<A HREF="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</A> location)</CODE>
311
312	<BR>
313	Sets the location of this target's definition.</TD>
314	</TR>
315	<TR BGCOLOR="white" CLASS="TableRowColor">
316	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
317	<CODE> void</CODE></FONT></TD>
318	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#setName(java.lang.String)">setName</A></B>(java.lang.String name)</CODE>
319
320	<BR>
321	Sets the name of this target.</TD>
322	</TR>
323	<TR BGCOLOR="white" CLASS="TableRowColor">
324	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
325	<CODE> void</CODE></FONT></TD>
326	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#setProject(org.apache.tools.ant.Project)">setProject</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project)</CODE>
327
328	<BR>
329	Sets the project this target belongs to.</TD>
330	</TR>
331	<TR BGCOLOR="white" CLASS="TableRowColor">
332	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
333	<CODE> void</CODE></FONT></TD>
334	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#setUnless(java.lang.String)">setUnless</A></B>(java.lang.String property)</CODE>
335
336	<BR>
337	Sets the "unless" condition to test on execution.</TD>
338	</TR>
339	<TR BGCOLOR="white" CLASS="TableRowColor">
340	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
341	<CODE> java.lang.String</CODE></FONT></TD>
342	<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/Target.html#toString()">toString</A></B>()</CODE>
343
344	<BR>
345	Returns the name of this target.</TD>
346	</TR>
347	</TABLE>
348	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
349	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
350	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
351	<TD><B>Methods inherited from class java.lang.Object</B></TD>
352	</TR>
353	<TR BGCOLOR="white" CLASS="TableRowColor">
354	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
355	</TR>
356	</TABLE>
357
358	<P>
359
360	<!-- ============ FIELD DETAIL =========== -->
361
362
363	<!-- ========= CONSTRUCTOR DETAIL ======== -->
364
365	<A NAME="constructor_detail"><!-- --></A>
366	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
367	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
368	<TD COLSPAN=1><FONT SIZE="+2">
369	<B>Constructor Detail</B></FONT></TD>
370	</TR>
371	</TABLE>
372
373	<A NAME="Target()"><!-- --></A><H3>
374	Target</H3>
375	<PRE>
376	public <B>Target</B>()</PRE>
377	<DL>
378	<DD>Sole constructor.
379	<P>
380	</DL>
381
382	<!-- ============ METHOD DETAIL ========== -->
383
384	<A NAME="method_detail"><!-- --></A>
385	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
386	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
387	<TD COLSPAN=1><FONT SIZE="+2">
388	<B>Method Detail</B></FONT></TD>
389	</TR>
390	</TABLE>
391
392	<A NAME="setProject(org.apache.tools.ant.Project)"><!-- --></A><H3>
393	setProject</H3>
394	<PRE>
395	public void <B>setProject</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project)</PRE>
396	<DL>
397	<DD>Sets the project this target belongs to.
398	<P>
399	<DD><DL>
400	</DL>
401	</DD>
402	<DD><DL>
403	<DT><B>Parameters:</B><DD><CODE>project</CODE> - The project this target belongs to.
404	Must not be <code>null</code>.</DL>
405	</DD>
406	</DL>
407	<HR>
408
409	<A NAME="getProject()"><!-- --></A><H3>
410	getProject</H3>
411	<PRE>
412	public <A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> <B>getProject</B>()</PRE>
413	<DL>
414	<DD>Returns the project this target belongs to.
415	<P>
416	<DD><DL>
417	</DL>
418	</DD>
419	<DD><DL>
420
421	<DT><B>Returns:</B><DD>The project this target belongs to, or <code>null</code> if
422	the project has not been set yet.</DL>
423	</DD>
424	</DL>
425	<HR>
426
427	<A NAME="setLocation(org.apache.tools.ant.Location)"><!-- --></A><H3>
428	setLocation</H3>
429	<PRE>
430	public void <B>setLocation</B>(<A HREF="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</A> location)</PRE>
431	<DL>
432	<DD>Sets the location of this target's definition.
433	<P>
434	<DD><DL>
435	</DL>
436	</DD>
437	<DD><DL>
438	<DT><B>Parameters:</B><DD><CODE>location</CODE> - <CODE>Location</CODE><DT><B>Since:</B></DT>
439	<DD>1.6.2</DD>
440	</DL>
441	</DD>
442	</DL>
443	<HR>
444
445	<A NAME="getLocation()"><!-- --></A><H3>
446	getLocation</H3>
447	<PRE>
448	public <A HREF="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</A> <B>getLocation</B>()</PRE>
449	<DL>
450	<DD>Get the location of this target's definition.
451	<P>
452	<DD><DL>
453	</DL>
454	</DD>
455	<DD><DL>
456
457	<DT><B>Returns:</B><DD><CODE>Location</CODE><DT><B>Since:</B></DT>
458	<DD>1.6.2</DD>
459	</DL>
460	</DD>
461	</DL>
462	<HR>
463
464	<A NAME="setDepends(java.lang.String)"><!-- --></A><H3>
465	setDepends</H3>
466	<PRE>
467	public void <B>setDepends</B>(java.lang.String depS)</PRE>
468	<DL>
469	<DD>Sets the list of targets this target is dependent on.
470	The targets themselves are not resolved at this time.
471	<P>
472	<DD><DL>
473	</DL>
474	</DD>
475	<DD><DL>
476	<DT><B>Parameters:</B><DD><CODE>depS</CODE> - A comma-separated list of targets this target
477	depends on. Must not be <code>null</code>.</DL>
478	</DD>
479	</DL>
480	<HR>
481
482	<A NAME="setName(java.lang.String)"><!-- --></A><H3>
483	setName</H3>
484	<PRE>
485	public void <B>setName</B>(java.lang.String name)</PRE>
486	<DL>
487	<DD>Sets the name of this target.
488	<P>
489	<DD><DL>
490	</DL>
491	</DD>
492	<DD><DL>
493	<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of this target. Should not be <code>null</code>.</DL>
494	</DD>
495	</DL>
496	<HR>
497
498	<A NAME="getName()"><!-- --></A><H3>
499	getName</H3>
500	<PRE>
501	public java.lang.String <B>getName</B>()</PRE>
502	<DL>
503	<DD>Returns the name of this target.
504	<P>
505	<DD><DL>
506	</DL>
507	</DD>
508	<DD><DL>
509
510	<DT><B>Returns:</B><DD>the name of this target, or <code>null</code> if the
511	name has not been set yet.</DL>
512	</DD>
513	</DL>
514	<HR>
515
516	<A NAME="addTask(org.apache.tools.ant.Task)"><!-- --></A><H3>
517	addTask</H3>
518	<PRE>
519	public void <B>addTask</B>(<A HREF="../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> task)</PRE>
520	<DL>
521	<DD>Adds a task to this target.
522	<P>
523	<DD><DL>
524	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/tools/ant/TaskContainer.html#addTask(org.apache.tools.ant.Task)">addTask</A></CODE> in interface <CODE><A HREF="../../../../org/apache/tools/ant/TaskContainer.html" title="interface in org.apache.tools.ant">TaskContainer</A></CODE></DL>
525	</DD>
526	<DD><DL>
527	<DT><B>Parameters:</B><DD><CODE>task</CODE> - The task to be added. Must not be <code>null</code>.</DL>
528	</DD>
529	</DL>
530	<HR>
531
532	<A NAME="addDataType(org.apache.tools.ant.RuntimeConfigurable)"><!-- --></A><H3>
533	addDataType</H3>
534	<PRE>
535	public void <B>addDataType</B>(<A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html" title="class in org.apache.tools.ant">RuntimeConfigurable</A> r)</PRE>
536	<DL>
537	<DD>Adds the wrapper for a data type element to this target.
538	<P>
539	<DD><DL>
540	</DL>
541	</DD>
542	<DD><DL>
543	<DT><B>Parameters:</B><DD><CODE>r</CODE> - The wrapper for the data type element to be added.
544	Must not be <code>null</code>.</DL>
545	</DD>
546	</DL>
547	<HR>
548
549	<A NAME="getTasks()"><!-- --></A><H3>
550	getTasks</H3>
551	<PRE>
552	public <A HREF="../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A>[] <B>getTasks</B>()</PRE>
553	<DL>
554	<DD>Returns the current set of tasks to be executed by this target.
555	<P>
556	<DD><DL>
557	</DL>
558	</DD>
559	<DD><DL>
560
561	<DT><B>Returns:</B><DD>an array of the tasks currently within this target</DL>
562	</DD>
563	</DL>
564	<HR>
565
566	<A NAME="addDependency(java.lang.String)"><!-- --></A><H3>
567	addDependency</H3>
568	<PRE>
569	public void <B>addDependency</B>(java.lang.String dependency)</PRE>
570	<DL>
571	<DD>Adds a dependency to this target.
572	<P>
573	<DD><DL>
574	</DL>
575	</DD>
576	<DD><DL>
577	<DT><B>Parameters:</B><DD><CODE>dependency</CODE> - The name of a target this target is dependent on.
578	Must not be <code>null</code>.</DL>
579	</DD>
580	</DL>
581	<HR>
582
583	<A NAME="getDependencies()"><!-- --></A><H3>
584	getDependencies</H3>
585	<PRE>
586	public java.util.Enumeration <B>getDependencies</B>()</PRE>
587	<DL>
588	<DD>Returns an enumeration of the dependencies of this target.
589	<P>
590	<DD><DL>
591	</DL>
592	</DD>
593	<DD><DL>
594
595	<DT><B>Returns:</B><DD>an enumeration of the dependencies of this target</DL>
596	</DD>
597	</DL>
598	<HR>
599
600	<A NAME="dependsOn(java.lang.String)"><!-- --></A><H3>
601	dependsOn</H3>
602	<PRE>
603	public boolean <B>dependsOn</B>(java.lang.String other)</PRE>
604	<DL>
605	<DD>Does this target depend on the named target?
606	<P>
607	<DD><DL>
608	</DL>
609	</DD>
610	<DD><DL>
611	<DT><B>Parameters:</B><DD><CODE>other</CODE> - the other named target.
612	<DT><B>Returns:</B><DD>true if the target does depend on the named target<DT><B>Since:</B></DT>
613	<DD>Ant 1.6</DD>
614	</DL>
615	</DD>
616	</DL>
617	<HR>
618
619	<A NAME="setIf(java.lang.String)"><!-- --></A><H3>
620	setIf</H3>
621	<PRE>
622	public void <B>setIf</B>(java.lang.String property)</PRE>
623	<DL>
624	<DD>Sets the "if" condition to test on execution. This is the
625	name of a property to test for existence - if the property
626	is not set, the task will not execute. The property goes
627	through property substitution once before testing, so if
628	property <code>foo</code> has value <code>bar</code>, setting
629	the "if" condition to <code>${foo}_x</code> will mean that the
630	task will only execute if property <code>bar_x</code> is set.
631	<P>
632	<DD><DL>
633	</DL>
634	</DD>
635	<DD><DL>
636	<DT><B>Parameters:</B><DD><CODE>property</CODE> - The property condition to test on execution.
637	May be <code>null</code>, in which case
638	no "if" test is performed.</DL>
639	</DD>
640	</DL>
641	<HR>
642
643	<A NAME="getIf()"><!-- --></A><H3>
644	getIf</H3>
645	<PRE>
646	public java.lang.String <B>getIf</B>()</PRE>
647	<DL>
648	<DD>Returns the "if" property condition of this target.
649	<P>
650	<DD><DL>
651	</DL>
652	</DD>
653	<DD><DL>
654
655	<DT><B>Returns:</B><DD>the "if" property condition or <code>null</code> if no
656	"if" condition had been defined.<DT><B>Since:</B></DT>
657	<DD>1.6.2</DD>
658	</DL>
659	</DD>
660	</DL>
661	<HR>
662
663	<A NAME="setUnless(java.lang.String)"><!-- --></A><H3>
664	setUnless</H3>
665	<PRE>
666	public void <B>setUnless</B>(java.lang.String property)</PRE>
667	<DL>
668	<DD>Sets the "unless" condition to test on execution. This is the
669	name of a property to test for existence - if the property
670	is set, the task will not execute. The property goes
671	through property substitution once before testing, so if
672	property <code>foo</code> has value <code>bar</code>, setting
673	the "unless" condition to <code>${foo}_x</code> will mean that the
674	task will only execute if property <code>bar_x</code> isn't set.
675	<P>
676	<DD><DL>
677	</DL>
678	</DD>
679	<DD><DL>
680	<DT><B>Parameters:</B><DD><CODE>property</CODE> - The property condition to test on execution.
681	May be <code>null</code>, in which case
682	no "unless" test is performed.</DL>
683	</DD>
684	</DL>
685	<HR>
686
687	<A NAME="getUnless()"><!-- --></A><H3>
688	getUnless</H3>
689	<PRE>
690	public java.lang.String <B>getUnless</B>()</PRE>
691	<DL>
692	<DD>Returns the "unless" property condition of this target.
693	<P>
694	<DD><DL>
695	</DL>
696	</DD>
697	<DD><DL>
698
699	<DT><B>Returns:</B><DD>the "unless" property condition or <code>null</code>
700	if no "unless" condition had been defined.<DT><B>Since:</B></DT>
701	<DD>1.6.2</DD>
702	</DL>
703	</DD>
704	</DL>
705	<HR>
706
707	<A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
708	setDescription</H3>
709	<PRE>
710	public void <B>setDescription</B>(java.lang.String description)</PRE>
711	<DL>
712	<DD>Sets the description of this target.
713	<P>
714	<DD><DL>
715	</DL>
716	</DD>
717	<DD><DL>
718	<DT><B>Parameters:</B><DD><CODE>description</CODE> - The description for this target.
719	May be <code>null</code>, indicating that no
720	description is available.</DL>
721	</DD>
722	</DL>
723	<HR>
724
725	<A NAME="getDescription()"><!-- --></A><H3>
726	getDescription</H3>
727	<PRE>
728	public java.lang.String <B>getDescription</B>()</PRE>
729	<DL>
730	<DD>Returns the description of this target.
731	<P>
732	<DD><DL>
733	</DL>
734	</DD>
735	<DD><DL>
736
737	<DT><B>Returns:</B><DD>the description of this target, or <code>null</code> if no
738	description is available.</DL>
739	</DD>
740	</DL>
741	<HR>
742
743	<A NAME="setAddress(java.lang.String)"><!-- --></A><H3>
744	setAddress</H3>
745	<PRE>
746	public void <B>setAddress</B>(java.lang.String address)</PRE>
747	<DL>
748	<DD>Sets the address of this target.
749	<P>
750	<DD><DL>
751	</DL>
752	</DD>
753	<DD><DL>
754	<DT><B>Parameters:</B><DD><CODE>address</CODE> - The address of this target. Should not be <code>null</code>.</DL>
755	</DD>
756	</DL>
757	<HR>
758
759	<A NAME="getAddress()"><!-- --></A><H3>
760	getAddress</H3>
761	<PRE>
762	public java.lang.String <B>getAddress</B>()</PRE>
763	<DL>
764	<DD>Returns the address of this target.
765	<P>
766	<DD><DL>
767	</DL>
768	</DD>
769	<DD><DL>
770
771	<DT><B>Returns:</B><DD>the address of this target, or <code>null</code> if the
772	address has not been set yet.</DL>
773	</DD>
774	</DL>
775	<HR>
776
777	<A NAME="incrementNextSubAddress()"><!-- --></A><H3>
778	incrementNextSubAddress</H3>
779	<PRE>
780	public void <B>incrementNextSubAddress</B>()</PRE>
781	<DL>
782	<DD><DL>
783	</DL>
784	</DD>
785	<DD><DL>
786	</DL>
787	</DD>
788	</DL>
789	<HR>
790
791	<A NAME="getNextSubAddress()"><!-- --></A><H3>
792	getNextSubAddress</H3>
793	<PRE>
794	public int <B>getNextSubAddress</B>()</PRE>
795	<DL>
796	<DD><DL>
797	</DL>
798	</DD>
799	<DD><DL>
800	</DL>
801	</DD>
802	</DL>
803	<HR>
804
805	<A NAME="toString()"><!-- --></A><H3>
806	toString</H3>
807	<PRE>
808	public java.lang.String <B>toString</B>()</PRE>
809	<DL>
810	<DD>Returns the name of this target.
811	<P>
812	<DD><DL>
813	</DL>
814	</DD>
815	<DD><DL>
816
817	<DT><B>Returns:</B><DD>the name of this target, or <code>null</code> if the
818	name has not been set yet.</DL>
819	</DD>
820	</DL>
821	<HR>
822
823	<A NAME="execute()"><!-- --></A><H3>
824	execute</H3>
825	<PRE>
826	public void <B>execute</B>()
827	throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
828	<DL>
829	<DD>Executes the target if the "if" and "unless" conditions are
830	satisfied. Dependency checking should be done before calling this
831	method, as it does no checking of its own. If either the "if"
832	or "unless" test prevents this target from being executed, a verbose
833	message is logged giving the reason. It is recommended that clients
834	of this class call performTasks rather than this method so that
835	appropriate build events are fired.
836	<P>
837	<DD><DL>
838	</DL>
839	</DD>
840	<DD><DL>
841
842	<DT><B>Throws:</B>
843	<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if any of the tasks fail or if a data type
844	configuration fails.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/tools/ant/Target.html#performTasks()"><CODE>performTasks()</CODE></A>,
845	<A HREF="../../../../org/apache/tools/ant/Target.html#setIf(java.lang.String)"><CODE>setIf(String)</CODE></A>,
846	<A HREF="../../../../org/apache/tools/ant/Target.html#setUnless(java.lang.String)"><CODE>setUnless(String)</CODE></A></DL>
847	</DD>
848	</DL>
849	<HR>
850
851	<A NAME="performTasks()"><!-- --></A><H3>
852	performTasks</H3>
853	<PRE>
854	public final void <B>performTasks</B>()</PRE>
855	<DL>
856	<DD>Performs the tasks within this target (if the conditions are met),
857	firing target started/target finished messages around a call to
858	execute.
859	<P>
860	<DD><DL>
861	</DL>
862	</DD>
863	<DD><DL>
864	<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/tools/ant/Target.html#execute()"><CODE>execute()</CODE></A></DL>
865	</DD>
866	</DL>
867	<!-- ========= END OF CLASS DATA ========= -->
868	<HR>
869
870
871	<!-- ======= START OF BOTTOM NAVBAR ====== -->
872	<A NAME="navbar_bottom"><!-- --></A>
873	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
874	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
875	<TR>
876	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
877	<A NAME="navbar_bottom_firstrow"><!-- --></A>
878	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
879	<TR ALIGN="center" VALIGN="top">
880	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
881	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
882	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
883	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
884	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
885	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
886	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
887	</TR>
888	</TABLE>
889	</TD>
890	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
891	</EM>
892	</TD>
893	</TR>
894
895	<TR>
896	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
897	<A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html" title="class in org.apache.tools.ant"><B>PREV CLASS</B></A>
898	<A HREF="../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant"><B>NEXT CLASS</B></A></FONT></TD>
899	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
900	<A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
901	<A HREF="Target.html" target="_top"><B>NO FRAMES</B></A>
902	<SCRIPT type="text/javascript">
903	<!--
904	if(window==top) {
905	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
906	}
907	//-->
908	</SCRIPT>
909	<NOSCRIPT>
910	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
911	</NOSCRIPT>
912
913	</FONT></TD>
914	</TR>
915	<TR>
916	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
917	SUMMARY: NESTED \| FIELD \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
918	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
919	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
920	</TR>
921	</TABLE>
922	<A NAME="skip-navbar_bottom"></A>
923	<!-- ======== END OF BOTTOM NAVBAR ======= -->
924
925	<HR>
926	Copyright Â© 2000-2007 Apache Software Foundation. All Rights Reserved.
927	</BODY>
928	</HTML>

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

Download in other formats: