KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > condition > solo > ShareableCondition


1 /**
2  * $Id: ShareableCondition.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 com.idaremedia.antx.NoiseLevel;
32
33 /**
34  * A rule that can be evaluation from multiple tasks in multiple threads concurrently
35  *
36  * @since JWare/AntX 0.2
37  * @author ssmc, &copy;2002-2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
38  * @version 0.5
39  * @.safety n/a
40  * @.group api,infra
41  * @see BuildRule
42  **/
43
44 public interface ShareableCondition
45 {
46     /**
47      * Evaluates this condition and updates specified information if
48      * rule evaluates <i>false</i>.
49      * @param calr ultimate user of condition (non-null)
50      **/
51     boolean eval(ShareableConditionUser calr);
52
53
54     /**
55      * Returns this rule's dominant effect. If 'ERROR' a <i>false</i>
56      * evaluation might be a build-stopper. If 'WARNING' the rule will not
57      * abort the build process. If '<i>null</i>' the effect is either not
58      * known or has yet to be determined. Helps rule users determine if
59      * a referral is a compatible match.
60      **/
61     NoiseLevel getFailureEffect();
62 }
63
64 /* end-of-ShareableCondition.java */
65
Popular Tags