KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > ownhelpers > ReferenceHandle


1 /**
2  * $Id: ReferenceHandle.java 180 2007-03-15 12:56:38Z ssmc $
3  * Copyright 2005 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.ownhelpers;
30
31 import org.apache.tools.ant.ProjectComponent;
32 import org.apache.tools.ant.types.Reference;
33
34 /**
35  * Utility script element that lets you declare a reference as a standalone nested
36  * element.
37  *
38  * @since JWare/AntX 0.5
39  * @author ssmc, &copy;2005 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
40  * @version 0.5
41  * @.safety single
42  * @.group api,helper
43  **/

44
45 public final class ReferenceHandle extends ProjectComponent
46 {
47     /**
48      * Initializes a new reference handle.
49      **/

50     public ReferenceHandle()
51     {
52     }
53
54
55     /**
56      * Sets this handle's referred-to thing's reference.
57      * @param ref the reference (non-null)
58      **/

59     public void setRefId(Reference ref)
60     {
61         m_refId = ref;
62     }
63
64
65     /**
66      * Returns this handle's referred-to thingy's reference.
67      * Will return <i>null</i> if never set.
68      **/

69     public Reference getRefId()
70     {
71         return m_refId;
72     }
73
74
75     /**
76      * Tells this handle's user whether a missing reference
77      * is OK.
78      * @param halt <i>true</i> if missing refid is bad.
79      **/

80     public void setHaltIfMissing(boolean halt)
81     {
82         m_haltIfMissing = halt ? Boolean.TRUE : Boolean.FALSE;
83     }
84
85
86     /**
87      * Returns this handle's bad refid missing instruction.
88      * Will return <i>null</i> if never set explicitly.
89      **/

90     public Boolean JavaDoc getHaltIfMissingFlag()
91     {
92         return m_haltIfMissing;
93     }
94
95
96     private Reference m_refId;
97     private Boolean JavaDoc m_haltIfMissing;
98 }
99
100 /* end-of-ReferenceHandle.java */
Popular Tags