KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > flowcontrol > HardLimitEnabled


1 /**
2  * $Id: HardLimitEnabled.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;
30
31 /**
32  * Interface to any flow control component that supports the standard
33  * '<span class="src">maxloops=N</span>' and '<span class="src">haltifmax[yes|no]</span>'
34  * parameters.
35  *
36  * @since JWare/AntX 0.5
37  * @author ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
38  * @version 0.5
39  * @.safety n/a
40  * @.group api,helper
41  **/
42
43 public interface HardLimitEnabled
44 {
45     /**
46      * Gives this flow control task a hard limit to the
47      * number of times it can execute. This attribute serves mostly
48      * as an error handling mechanism to prevent infinite loops.
49      **/
50     void setMaxLoops(int maxLoops);
51
52
53
54     /**
55      * Tells this tasks whether to fail if the hard limit is
56      * reached. Ignored if this flow control task does not have a
57      * hard limit.
58      * @see #setMaxLoops setMaxLoops(LIMIT)
59      **/
60     void setHaltIfMax(boolean halt);
61 }
62
63 /* end-of-HardLimitEnabled.java */
Popular Tags