View Javadoc
1   package net.sourceforge.pmd.lang.vm.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   * Foreach directive used for moving through arrays,
24   * or objects that provide an Iterator.
25   *
26   * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
27   * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
28   * @author Daniel Rall
29   * @version $Id: Foreach.java 945927 2010-05-18 22:21:41Z nbubna $
30   */
31  public class Foreach extends Directive
32  {
33      /**
34       * Return name of this directive.
35       * @return The name of this directive.
36       */
37      public String getName()
38      {
39          return "foreach";
40      }
41  
42      /**
43       * Return type of this directive.
44       * @return The type of this directive.
45       */
46      public int getType()
47      {
48          return BLOCK;
49      }
50  
51  
52  }