View Javadoc

1   package org.apache.velocity.runtime.directive;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.    
20   */
21  
22  /**
23   * This represents scoping and metadata for #foreach,
24   * adding index, count, hasNext, isFirst and isLast info.
25   *
26   * @author Nathan Bubna
27   * @version $Id$
28   */
29  public class ForeachScope extends Scope
30  {
31      protected int index = -1;
32      protected boolean hasNext = false;
33  
34      public ForeachScope(Object owner, Object replaces)
35      {
36          super(owner, replaces);
37      }
38  
39      public int getIndex()
40      {
41          return index;
42      }
43  
44      public int getCount()
45      {
46          return index + 1;
47      }
48  
49      public boolean hasNext()
50      {
51          return getHasNext();
52      }
53  
54      public boolean getHasNext()
55      {
56          return hasNext;
57      }
58  
59      public boolean isFirst()
60      {
61          return index < 1;
62      }
63  
64      public boolean getFirst()
65      {
66          return isFirst();
67      }
68  
69      public boolean isLast()
70      {
71          return !hasNext;
72      }
73  
74      public boolean getLast()
75      {
76          return isLast();
77      }
78  
79  }