01: /*
02: * Copyright (c) 1998-2003 Caucho Technology -- all rights reserved
03: *
04: * This file is part of Resin(R) Open Source
05: *
06: * Each copy or derived work must preserve the copyright notice and this
07: * notice unmodified.
08: *
09: * Resin Open Source is free software; you can redistribute it and/or modify
10: * it under the terms of the GNU General Public License as published by
11: * the Free Software Foundation; either version 2 of the License, or
12: * (at your option) any later version.
13: *
14: * Resin Open Source is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17: * of NON-INFRINGEMENT. See the GNU General Public License for more
18: * details.
19: *
20: * You should have received a copy of the GNU General Public License
21: * along with Resin Open Source; if not, write to the
22: * Free SoftwareFoundation, Inc.
23: * 59 Temple Place, Suite 330
24: * Boston, MA 02111-1307 USA
25: *
26: * @author Scott Ferguson
27: */
28:
29: package javax.servlet.jsp.tagext;
30:
31: import javax.servlet.jsp.JspException;
32:
33: /**
34: * IterationTag lets tags loop over the body.
35: *
36: * <p>The generated code looks something like:
37: *
38: * <pre><code>
39: * if (tag.doStartTag() == EVAL_BODY_INCLUDE) {
40: * do {
41: * ...
42: * } while (tag.doAfterBody() == EVAL_BODY_AGAIN);
43: * }
44: * if (tag.doEndTag() == SKIP_PAGE)
45: * return;
46: * </code><pre>
47: */
48: public interface IterationTag extends Tag {
49: /**
50: * Constant to reiterate the body.
51: */
52: public final static int EVAL_BODY_AGAIN = 2;
53:
54: /**
55: * Tags call doAfterBody after processing the tag body. By returning
56: * EVAL_BODY_AGAIN, an iterator tag can repeat evaluation of the tag body.
57: *
58: * <p>empty tags and tags returning SKIP_BODY do not call
59: * doAfterBody.
60: *
61: * @return EVAL_BODY_AGAIN to repeat the tag and SKIP_PAGE to stop.
62: */
63: public int doAfterBody() throws JspException;
64: }
|