KickJava   Java API By Example, From Geeks To Geeks.

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


1 /**
2  * $Id: ConditionalInnerNameValuePair.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 com.idaremedia.antx.helpers.InnerNameValuePair;
32 import com.idaremedia.antx.parameters.Conditional;
33
34 /**
35  * Simple key-value parameter helper that supports optional inclusion using standard
36  * if/unless mechanism.
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 class ConditionalInnerNameValuePair extends InnerNameValuePair
46     implements Conditional
47 {
48     /**
49      * Initializes a new inner name/value pair.
50      **/
51     public ConditionalInnerNameValuePair()
52     {
53         super();
54     }
55
56
57
58     /**
59      * Creates new predefined pair.
60      **/
61     public ConditionalInnerNameValuePair(String JavaDoc name, String JavaDoc value)
62     {
63         super(name,value);
64     }
65
66
67
68     /**
69      * Sets this parameter's 'if' constraint.
70      * @param property name of guard property (non-null)
71      **/
72     public void setIf(String JavaDoc property)
73     {
74         m_ifProperty = property;
75     }
76
77     /**
78      * Returns this parameter's 'if' constraint or <i>null</i>
79      * if none set explicitly.
80      **/
81     public String JavaDoc getIfProperty()
82     {
83         return m_ifProperty;
84     }
85
86
87     /**
88      * Sets this parameter's 'unless' constraint.
89      * @param property name of guard property (non-null)
90      **/
91     public void setUnless(String JavaDoc property)
92     {
93         m_unProperty = property;
94     }
95
96
97     /**
98      * Returns this parameter's 'unless' constraint or <i>null</i>
99      * if none set explicitly.
100      **/
101     public String JavaDoc getUnlessProperty()
102     {
103         return m_unProperty;
104     }
105
106
107     private String JavaDoc m_ifProperty, m_unProperty;
108 }
109
110 /* end-of-ConditionalInnerNameValuePair.java */
Popular Tags