KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > flowcontrol > call > InlinedTarget


1 /**
2  * $Id: InlinedTarget.java 180 2007-03-15 12:56:38Z ssmc $
3  * Copyright 2002-2004 iDare Media, Inc. All rights reserved.
4  *
5  * Originally written by iDare Media, Inc. for release into the public domain. This
6  * library, source form and binary form, is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public License as published by the
8  * Free Software Foundation; either version 2.1 of the License, or (at your option) any
9  * later version.<p>
10  *
11  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
12  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13  * See the GNU LGPL (GNU Lesser General Public License) for more details.<p>
14  *
15  * You should have received a copy of the GNU Lesser General Public License along with this
16  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite
17  * 330, Boston, MA 02111-1307 USA. The LGPL can be found online at
18  * http://www.fsf.org/copyleft/lesser.html<p>
19  *
20  * This product has been influenced by several projects within the open-source community.
21  * The JWare developers wish to acknowledge the open-source community's support. For more
22  * information regarding the open-source products used within JWare, please visit the
23  * JWare website.
24  *----------------------------------------------------------------------------------------*
25  * WEBSITE- http://www.jware.info EMAIL- inquiries@jware.info
26  *----------------------------------------------------------------------------------------*
27  **/
28
29 package com.idaremedia.antx.flowcontrol.call;
30
31 import org.apache.tools.ant.BuildException;
32 import org.apache.tools.ant.Project;
33 import org.apache.tools.ant.Target;
34 import org.apache.tools.ant.Task;
35 import org.apache.tools.ant.TaskContainer;
36
37 import com.idaremedia.antx.apis.Nameable;
38 import com.idaremedia.antx.apis.ProjectDependent;
39
40 /**
41  * Target that's inlined inside another standard Ant target. Usually called by a
42  * {@linkplain StepLauncher}.
43  *
44  * @since JWare/AntX 0.1
45  * @author ssmc, &copy;2002-2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
46  * @version 0.5
47  * @.safety n/a
48  * @.group api,infra
49  **/
50
51 public interface InlinedTarget extends Runnable JavaDoc, Nameable,
52                                        ProjectDependent, TaskContainer
53 {
54     /**
55      * Updates this step's project.
56      **/
57     void setProject(Project p);
58
59
60     /**
61      * Returns this step's project.
62      **/
63     Project getProject();
64
65
66     /**
67      * Updates this step's owning target.
68      **/
69     void setOwningTarget(Target t);
70
71
72     /**
73      * Returns this step's owning target.
74      **/
75     Target getOwningTarget();
76
77
78     /**
79      * Sets this step's human-readable description.
80      * @param description new description (same conditions as a target)
81      */
82     void setDescription(String JavaDoc description);
83
84
85     /**
86      * Returns this step's description. Can return <i>null</i>
87      * if never set.
88      **/
89     String JavaDoc getDescription();
90
91
92     /**
93      * Adds a sub-task or customization property to this step;
94      * optionally "exposed" operation.
95      * @throws BuildException if not permitted directly
96      **/
97     void addTask(Task t) throws BuildException;
98
99
100     /**
101      * Returns a copy of this step's sub-tasks or customization
102      * properties.
103      **/
104     Task[] getTasks();
105 }
106
107 /* end-of-InlinedTarget.java */
108
Popular Tags