KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > condition > solo > NeverTask


1 /**
2  * $Id: NeverTask.java 186 2007-03-16 13:42:35Z 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.condition.solo;
30
31 import org.apache.tools.ant.Task;
32
33 import com.idaremedia.antx.AntX;
34 import com.idaremedia.antx.apis.TestScriptComponent;
35 import com.idaremedia.antx.ownhelpers.LocalTk;
36
37 /**
38  * Test task that unconditionally throws an standard Error. See the {@linkplain
39  * com.idaremedia.antx.flowcontrol.StopTask StopTask} for a build-script variant of
40  * Never. <b>Implementation Note:</b> a NeverTask throws a plain <code>java.lang.Error</code>
41  * to differentiate it from an AntX BuildError. This allows tests to determine if an
42  * expected BuildError was generated instead of a Never error.
43  *
44  * @since JWare/AntX 0.2
45  * @author ssmc, &copy;2002-2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
46  * @version 0.5
47  * @.safety multiple
48  * @.group impl,test,helper
49  * @see com.idaremedia.antx.flowcontrol.StopTask
50  **/
51
52 public final class NeverTask extends Task
53     implements TestScriptComponent
54 {
55     /**
56      * Initializes a new NeverTask.
57      **/
58     public NeverTask()
59     {
60         super();
61     }
62
63
64
65     /**
66      * Assigns this task a custom script message to display.
67      * @param message the message (non-null)
68      * @since JWare/AntX 0.5
69      **/
70     public void setMsg(String JavaDoc message)
71     {
72         m_errorMsg = message;
73     }
74
75
76
77     /**
78      * Throws an Error.
79      * @throws Error always
80      **/
81     public void execute()
82     {
83         String JavaDoc info = m_errorMsg;
84         if (info==null) {
85             String JavaDoc plocation = LocalTk.purtyLocation(getLocation());
86             info = AntX.uistrs().get("never.msg",plocation);
87         }
88         throw new Error JavaDoc(info);
89     }
90     
91
92     private String JavaDoc m_errorMsg;
93 }
94
95 /* end-of-NeverTask.java */
96
Popular Tags