ShareableConditionUser


1   /**
2    * $Id: ShareableConditionUser.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.condition.solo;
30  
31  import  org.apache.tools.ant.Location;
32  
33  /**
34   * Caller-specific attributes used by a shared build rule during an evaluation.
35   * Build rules are shareable entities that can be evaluated from multiple
36   * threads concurrently. To ensure that each thread can define and mutate its own
37   * update information, a thread-specific "packet" of information is maintained by every
38   * {@linkplain ShareableCondition} implementation.
39   *
40   * @since    JWare/AntX 0.2
41   * @author   ssmc, &copy;2002-2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
42   * @version  0.5
43   * @.safety  n/a
44   * @.group   api,infra
45   * @see      BuildRule
46   * @see      ShareableCondition
47   **/
48  
49  public interface ShareableConditionUser
50  {
51      /**
52       * Returns the caller's msgid.
53       **/
54      String   getMsgId();
55  
56  
57      /**
58       * Returns the caller's location.
59       **/
60      Location getLocation();
61  
62  
63      /**
64       * Returns the property to be updated if condition is <i>false</i>.
65       **/
66      String   getUpdateProperty();
67  
68  
69      /**
70       * Returns the variable to be updated if condition is <i>false</i>.
71       **/
72      String   getUpdateVariable();
73  
74  
75      /**
76       * Returns value to use to update either or both the update property
77       * and the update variable.
78       * @see #getUpdateProperty
79       * @see #getUpdateVariable
80       **/
81      String   getUpdateValue();
82  }
83  
84  /* end-of-ShareableConditionUser.java */
85
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags