KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > flowcontrol > wrap > ConditionalLocal


1 /**
2  * $Id: ConditionalLocal.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.flowcontrol.wrap;
30
31 import com.idaremedia.antx.helpers.InnerNameValuePair;
32 import com.idaremedia.antx.helpers.Tk;
33
34 /**
35  * A local parameter that can be conditionally applied.
36  *
37  * @since JWare/AntX 0.5
38  * @author ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
39  * @version 0.5
40  * @.safety single
41  * @.group api,helper
42  * @see Locals
43  **/
44
45 public final class ConditionalLocal extends InnerNameValuePair
46 {
47     /**
48      * Initializes a new conditional parameter.
49      **/
50     public ConditionalLocal()
51     {
52         setNull();
53     }
54
55
56     /**
57      * Sets ths local's true condition evaluation <em>result</em>.
58      * If the incoming string is a positive boolean string then
59      * the "if condition" will pass.
60      * @param boolstr the evaluation's result (non-null)
61      **/
62     public void setIf(String JavaDoc boolstr)
63     {
64         m_enabled = m_enabled &&
65             Boolean.TRUE.equals(Tk.string2PosBool(boolstr));
66     }
67
68
69
70     /**
71      * Sets ths local's false condition evaluation <em>result</em>.
72      * If the incoming string is a positive boolean string then
73      * the "unless condition" will fail.
74      * @param boolstr the evaluation's result (non-null)
75      **/
76     public void setUnless(String JavaDoc boolstr)
77     {
78         m_enabled = m_enabled &&
79             !Boolean.TRUE.equals(Tk.string2PosBool(boolstr));
80     }
81
82
83
84     /**
85      * Returns <i>true</i> if this local's apply test(s) allow
86      * installation.
87      **/
88     public final boolean isEnabled()
89     {
90         return m_enabled;
91     }
92
93
94
95     /**
96      * Indicates whether this item should inherit its initial
97      * value from the surrounding context. The default setting
98      * of this property depends on the target fixture element.
99      * @param inherit <i>true</i> to always inherit
100      **/
101     public void setInherit(boolean inherit)
102     {
103         m_inherit = inherit ? Boolean.TRUE : Boolean.FALSE;
104     }
105
106
107
108     /**
109      * Returns this item's inherit flag setting. Will return
110      * <i>null</i> if never set explicitly.
111      **/
112     public final Boolean JavaDoc getInheritFlag()
113     {
114         return m_inherit;
115     }
116
117
118     private boolean m_enabled = true;
119     private Boolean JavaDoc m_inherit;
120 }
121
122 /* end-of-ConditionalLocal.java */
Popular Tags