Conditional


1   /**
2    * $Id: Conditional.java 180 2007-03-15 12:56:38Z 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.parameters;
30  
31  /**
32   * A component that supports standard if/unless conditional execution. A conditional's
33   * execution is determined by the <em>combination</em> of its <i>if</i>  and <i>unless</i>
34   * conditions.
35   * <p>
36   * <b>Examples:</b><pre>
37   *      &lt;stop if="..." msgid="..."/&gt;
38   *      &lt;show msgid="..." unless="..."/&gt;
39   *      &lt;do iftrue="..." unless="..."&gt;...
40   *      &lt;print if="..."&gt;...
41   * </pre>
42   *
43   * @since    JWare/AntX 0.2
44   * @author   ssmc, &copy;2002-2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
45   * @version  0.5
46   * @.safety  n/a
47   * @.group   api,infra
48   * @see      com.idaremedia.antx.go.Iff Iff
49   * @see      com.idaremedia.antx.go.Unless Unless
50   **/
51  
52  public interface Conditional
53  {
54      /**
55       * Adds an if-condition to this component.
56       **/
57      void setIf(String   property);
58  
59  
60      /**
61       * Returns this components's (raw) if-condition if any. Returns
62       * empty string if condition never set.
63       **/
64      String   getIfProperty();
65  
66  
67      /**
68       * Adds an unless-condition to this component.
69       **/
70      void setUnless(String   property);
71  
72  
73      /**
74       * Returns this component's (raw) unless-condition if any.
75       * Returns empty string if condition never set.
76       **/
77      String   getUnlessProperty();
78  }
79  
80  /* end-of-Conditional.java */
81
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags