Save This Page
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * Portions Copyright Apache Software Foundation.
7 *
8 * The contents of this file are subject to the terms of either the GNU
9 * General Public License Version 2 only ("GPL") or the Common Development
10 * and Distribution License("CDDL") (collectively, the "License"). You
11 * may not use this file except in compliance with the License. You can obtain
12 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
13 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
14 * language governing permissions and limitations under the License.
15 *
16 * When distributing the software, include this License Header Notice in each
17 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
18 * Sun designates this particular file as subject to the "Classpath" exception
19 * as provided by Sun in the GPL Version 2 section of the License file that
20 * accompanied this code. If applicable, add the following below the License
21 * Header, with the fields enclosed by brackets [] replaced by your own
22 * identifying information: "Portions Copyrighted [year]
23 * [name of copyright owner]"
24 *
25 * Contributor(s):
26 *
27 * If you wish your version of this file to be governed by only the CDDL or
28 * only the GPL Version 2, indicate your decision by adding "[Contributor]
29 * elects to include this software in this distribution under the [CDDL or GPL
30 * Version 2] license." If you don't indicate a single choice of license, a
31 * recipient has the option to distribute your version of this file under
32 * either the CDDL, the GPL Version 2 or to extend the choice of license to
33 * its licensees as provided above. However, if you add GPL Version 2 code
34 * and therefore, elected the GPL Version 2 license, then the option applies
35 * only if the new code is made subject to such option by the copyright
36 * holder.
37 */
38
39 package javax.servlet.jsp.jstl.core;
40
41 import javax.servlet.jsp.tagext.Tag;
42
43 /**
44 * <p>JSTL allows developers to write custom iteration tags by
45 * implementing the LoopTag interface. This is not to be confused
46 * with <tt>javax.servlet.jsp.tagext.IterationTag</tt> as defined in JSP 1.2.
47 * LoopTag establishes a mechanism for iteration tags to be recognized
48 * and for type-safe implicit collaboration with custom subtags.
49 *
50 * <p>In most cases, it will not be necessary to implement this interface
51 * manually, for a base support class (<tt>LoopTagSupport</tt>) is provided
52 * to facilitate implementation.</p>
53 *
54 * @author Shawn Bayern
55 */
56
57 public interface LoopTag extends Tag {
58
59 /**
60 * Retrieves the current item in the iteration. Behaves
61 * idempotently; calling getCurrent() repeatedly should return the same
62 * Object until the iteration is advanced. (Specifically, calling
63 * getCurrent() does <b>not</b> advance the iteration.)
64 *
65 * @return the current item as an object
66 */
67 public Object getCurrent();
68
69 /**
70 * Retrieves a 'status' object to provide information about the
71 * current round of the iteration.
72 *
73 * @return The LoopTagStatus for the current <tt>LoopTag</tt>.
74 */
75 public LoopTagStatus getLoopStatus();
76 }