|
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
- <!--NewPage-->
- <HTML>
- <HEAD>
- <!-- Generated by javadoc on Sat Dec 16 22:19:46 EST 2000 -->
- <TITLE>
- : Interface Task
- </TITLE>
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
- </HEAD>
- <BODY BGCOLOR="white">
-
- <!-- ========== START OF NAVBAR ========== -->
- <A NAME="navbar_top"><!-- --></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_top_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
-
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- PREV CLASS
- NEXT CLASS</FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
- <A HREF="Task.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <!-- =========== END OF NAVBAR =========== -->
-
- <HR>
- <!-- ======== START OF CLASS DATA ======== -->
- <H2>
- <FONT SIZE="-1">
- org.apache.ant.tasks</FONT>
- <BR>
- Interface Task</H2>
- <HR>
- <DL>
- <DT>public interface <B>Task</B></DL>
-
- <P>
- Task is the core interface for all structures that will be processed by the
- TaskEngine.
- <P>
- <HR>
-
- <P>
- <!-- ======== INNER CLASS SUMMARY ======== -->
-
-
- <!-- =========== FIELD SUMMARY =========== -->
-
- <A NAME="field_summary"><!-- --></A>
- <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=2><FONT SIZE="+2">
- <B>Field Summary</B></FONT></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#EXECUTION_MODE_EXPLICIT">EXECUTION_MODE_EXPLICIT</A></B></CODE>
-
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#EXECUTION_MODE_IMPLICIT">EXECUTION_MODE_IMPLICIT</A></B></CODE>
-
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#EXECUTION_MODE_PRIORITY">EXECUTION_MODE_PRIORITY</A></B></CODE>
-
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static char</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#NAME_SEPARATOR">NAME_SEPARATOR</A></B></CODE>
-
- <BR>
- </TD>
- </TR>
- </TABLE>
-
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
-
-
- <!-- ========== METHOD SUMMARY =========== -->
-
- <A NAME="method_summary"><!-- --></A>
- <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=2><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#execute(org.apache.ant.engine.TaskEngine)">execute</A></B>(org.apache.ant.engine.TaskEngine engine)</CODE>
-
- <BR>
- Causes the existing Task implementation to execute.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getAttributeValue(java.lang.String)">getAttributeValue</A></B>(java.lang.String name)</CODE>
-
- <BR>
- Each Task will hold its attributes in some manner.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A>[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getChildren()">getChildren</A></B>()</CODE>
-
- <BR>
- Returns the an array of Task objects that are subordinate to this Task.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getExecutionMode()">getExecutionMode</A></B>()</CODE>
-
- <BR>
- Determines whether this Task is executed whenever its parent is executed,
- or if its execution must be specifically requested.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getFullyQualifiedName()">getFullyQualifiedName</A></B>()</CODE>
-
- <BR>
- The "fully-qualified" name of a Task is the Task's name, prepended by its
- parent's name, prepended by its parent's name, etc.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getParent()">getParent</A></B>()</CODE>
-
- <BR>
- Returns this Task's parent Task.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getRootTask()">getRootTask</A></B>()</CODE>
-
- <BR>
- Proceed backwards through the nodes until we come across the first Task
- in the tree.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getTask(java.lang.String)">getTask</A></B>(java.lang.String taskPath)</CODE>
-
- <BR>
- A mechanism for locating a task relative to the current task.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#getTaskName()">getTaskName</A></B>()</CODE>
-
- <BR>
- Just a simple name used to identify a Task.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#init(org.apache.ant.engine.TaskEngine)">init</A></B>(org.apache.ant.engine.TaskEngine engine)</CODE>
-
- <BR>
- Called when the Task first gets "noticed" by the TaskEngine.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#isPropertyContainer()">isPropertyContainer</A></B>()</CODE>
-
- <BR>
- Determines whether a Task is suitable for holding property values.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#setParent(org.apache.ant.tasks.Task)">setParent</A></B>(<A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A> parent)</CODE>
-
- <BR>
- Sets the Task's parent.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/apache/ant/tasks/Task.html#validate()">validate</A></B>()</CODE>
-
- <BR>
- Each Task should have the ability to validate its state.</TD>
- </TR>
- </TABLE>
-
- <P>
-
- <!-- ============ FIELD DETAIL =========== -->
-
- <A NAME="field_detail"><!-- --></A>
- <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=1><FONT SIZE="+2">
- <B>Field Detail</B></FONT></TD>
- </TR>
- </TABLE>
-
- <A NAME="EXECUTION_MODE_IMPLICIT"><!-- --></A><H3>
- EXECUTION_MODE_IMPLICIT</H3>
- <PRE>
- public static final int <B>EXECUTION_MODE_IMPLICIT</B></PRE>
- <DL>
- </DL>
- <HR>
-
- <A NAME="EXECUTION_MODE_EXPLICIT"><!-- --></A><H3>
- EXECUTION_MODE_EXPLICIT</H3>
- <PRE>
- public static final int <B>EXECUTION_MODE_EXPLICIT</B></PRE>
- <DL>
- </DL>
- <HR>
-
- <A NAME="EXECUTION_MODE_PRIORITY"><!-- --></A><H3>
- EXECUTION_MODE_PRIORITY</H3>
- <PRE>
- public static final int <B>EXECUTION_MODE_PRIORITY</B></PRE>
- <DL>
- </DL>
- <HR>
-
- <A NAME="NAME_SEPARATOR"><!-- --></A><H3>
- NAME_SEPARATOR</H3>
- <PRE>
- public static final char <B>NAME_SEPARATOR</B></PRE>
- <DL>
- </DL>
-
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
-
-
- <!-- ============ METHOD DETAIL ========== -->
-
- <A NAME="method_detail"><!-- --></A>
- <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TD COLSPAN=1><FONT SIZE="+2">
- <B>Method Detail</B></FONT></TD>
- </TR>
- </TABLE>
-
- <A NAME="execute(org.apache.ant.engine.TaskEngine)"><!-- --></A><H3>
- execute</H3>
- <PRE>
- public void <B>execute</B>(org.apache.ant.engine.TaskEngine engine)
- throws org.apache.ant.AntException</PRE>
- <DL>
- <DD>Causes the existing Task implementation to execute.</DL>
- <HR>
-
- <A NAME="init(org.apache.ant.engine.TaskEngine)"><!-- --></A><H3>
- init</H3>
- <PRE>
- public void <B>init</B>(org.apache.ant.engine.TaskEngine engine)
- throws org.apache.ant.AntException</PRE>
- <DL>
- <DD>Called when the Task first gets "noticed" by the TaskEngine.</DL>
- <HR>
-
- <A NAME="validate()"><!-- --></A><H3>
- validate</H3>
- <PRE>
- public void <B>validate</B>()
- throws org.apache.ant.AntException</PRE>
- <DL>
- <DD>Each Task should have the ability to validate its state. This would be
- invoked by the TaskEngine prior to commencing an execution cycle.</DL>
- <HR>
-
- <A NAME="getTaskName()"><!-- --></A><H3>
- getTaskName</H3>
- <PRE>
- public java.lang.String <B>getTaskName</B>()</PRE>
- <DL>
- <DD>Just a simple name used to identify a Task. This name is only sufficient
- for simple debugging and GUI output. It does not uniquely identify a
- Task.<DD><DL>
- <DT><B>See Also: </B><DD><A HREF="../../../../org/apache/ant/tasks/Task.html#getFullyQualifiedName()"><CODE>getFullyQualifiedName()</CODE></A></DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="getTask(java.lang.String)"><!-- --></A><H3>
- getTask</H3>
- <PRE>
- public <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A> <B>getTask</B>(java.lang.String taskPath)</PRE>
- <DL>
- <DD>A mechanism for locating a task relative to the current task. This
- navigation sceme will mimic a typical OS system. '..' will move back
- a level in the Task tree. If taskPath begins with '/' then the root node
- will be used as a starting point.
- <p></p>
- Returns null of no task is found at this location.</DL>
- <HR>
-
- <A NAME="getRootTask()"><!-- --></A><H3>
- getRootTask</H3>
- <PRE>
- public <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A> <B>getRootTask</B>()</PRE>
- <DL>
- <DD>Proceed backwards through the nodes until we come across the first Task
- in the tree. This is the root Task.</DL>
- <HR>
-
- <A NAME="getFullyQualifiedName()"><!-- --></A><H3>
- getFullyQualifiedName</H3>
- <PRE>
- public java.lang.String <B>getFullyQualifiedName</B>()</PRE>
- <DL>
- <DD>The "fully-qualified" name of a Task is the Task's name, prepended by its
- parent's name, prepended by its parent's name, etc. This method may be
- used by the Task's hashCode() method to calculate a hash that will
- uniquely identify a Task.</DL>
- <HR>
-
- <A NAME="getExecutionMode()"><!-- --></A><H3>
- getExecutionMode</H3>
- <PRE>
- public int <B>getExecutionMode</B>()</PRE>
- <DL>
- <DD>Determines whether this Task is executed whenever its parent is executed,
- or if its execution must be specifically requested.
- <p></p>
- <dl><dt>EXECUTION_MODE_EXPLICIT</dt>
- <dd>Requires interaction by the TaskEngine in order to execute.</dd>
- <dt>EXECUTION_MODE_IMPLICIT</dt>
- <dd>This Task is automatically executed when its parent is
- executed.</dd>
- <dt>EXECUTION_MODE_PRIORITY</dt>
- <dd>These Tasks are executed prior to its parent's execution</dd></dl>
- <p></p>
- The default mode should probably be EXECUTION_MODE_IMPLICIT. In the
- build domain of Ant, every Task below a Task will normally be executed.
- The major exception to this is the Target. When a Project Task is
- executed, all Target Tasks do <i>not</i> automatically fire, however all
- Property Tasks <i>do</i> execute.</DL>
- <HR>
-
- <A NAME="isPropertyContainer()"><!-- --></A><H3>
- isPropertyContainer</H3>
- <PRE>
- public boolean <B>isPropertyContainer</B>()</PRE>
- <DL>
- <DD>Determines whether a Task is suitable for holding property values.</DL>
- <HR>
-
- <A NAME="getAttributeValue(java.lang.String)"><!-- --></A><H3>
- getAttributeValue</H3>
- <PRE>
- public java.lang.String <B>getAttributeValue</B>(java.lang.String name)</PRE>
- <DL>
- <DD>Each Task will hold its attributes in some manner. This method will allow
- the Task implementation to return the value of its attribute.</DL>
- <HR>
-
- <A NAME="getParent()"><!-- --></A><H3>
- getParent</H3>
- <PRE>
- public <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A> <B>getParent</B>()</PRE>
- <DL>
- <DD>Returns this Task's parent Task. If this Task is the root Task, then this
- method will return null.</DL>
- <HR>
-
- <A NAME="setParent(org.apache.ant.tasks.Task)"><!-- --></A><H3>
- setParent</H3>
- <PRE>
- public void <B>setParent</B>(<A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A> parent)</PRE>
- <DL>
- <DD>Sets the Task's parent.</DL>
- <HR>
-
- <A NAME="getChildren()"><!-- --></A><H3>
- getChildren</H3>
- <PRE>
- public <A HREF="../../../../org/apache/ant/tasks/Task.html">Task</A>[] <B>getChildren</B>()</PRE>
- <DL>
- <DD>Returns the an array of Task objects that are subordinate to this Task.</DL>
- <!-- ========= END OF CLASS DATA ========= -->
- <HR>
-
- <!-- ========== START OF NAVBAR ========== -->
- <A NAME="navbar_bottom"><!-- --></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_bottom_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
-
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- PREV CLASS
- NEXT CLASS</FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
- <A HREF="Task.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <!-- =========== END OF NAVBAR =========== -->
-
- <HR>
-
- </BODY>
- </HTML>
|
