KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > helpers > TaskHandle


1 /**
2  * $Id: TaskHandle.java 180 2007-03-15 12:56:38Z ssmc $
3  * Copyright 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 (LGPL) as published
8  * by the Free Software Foundation; either version 2.1 of the License, or (at your option)
9  * any 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 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 GNU 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.helpers;
30
31 import org.apache.tools.ant.Task;
32
33 /**
34  * ResultObject wrapper for a Task reference.
35  *
36  * @since JWare/AntX 0.4
37  * @author ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
38  * @version 0.5
39  * @.safety single
40  * @.group impl,helper
41  * @.pattern Fowler.ResultObject
42  **/

43
44 public final class TaskHandle
45 {
46     /**
47      * Initializes an empty task handle.
48      **/

49     public TaskHandle()
50     {
51     }
52
53
54     /**
55      * Initializes a pre-filled task handle.
56      **/

57     public TaskHandle(Task t)
58     {
59         m_task = t;
60     }
61
62
63     /**
64      * Returns this handle's underlying task. Can
65      * return <i>null</i> if handle empty.
66      **/

67     public Task getTask()
68     {
69         return m_task;
70     }
71
72
73
74     /**
75      * Updates this handle's underlying task.
76      * @param t new task (can be <i>null</i>)
77      **/

78     public void setTask(Task t)
79     {
80         m_task = t;
81     }
82
83
84     /**
85      * Clears this handle's underlying task.
86      **/

87     public void clrTask()
88     {
89         m_task = null;
90     }
91
92
93     /**
94      * Returns <i>true</i> if this handle has no
95      * underlying task.
96      **/

97     public boolean isEmpty()
98     {
99         return m_task==null;
100     }
101
102
103     /**
104      * Returns this handle's underlying task's name
105      * or empty string if no task.
106      **/

107     public String JavaDoc getTaskName()
108     {
109         return m_task==null ? "" : m_task.getTaskName();
110     }
111
112
113
114     private Task m_task;
115 }
116
117 /* end-of-TaskHandle.java */
118
Popular Tags