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   * Directive that puts an unrendered AST block in the context
24   * under the specified key, postponing rendering until the
25   * reference is used and rendered.
26   *
27   * @author Andrew Tetlaw
28   * @author Nathan Bubna
29   * @author <a href="mailto:wyla@removethis.sci.fi">Jarkko Viinamaki</a>
30   * @since 1.7
31   * @version $Id: Block.java 686842 2008-08-18 18:29:31Z nbubna $
32   */
33  public abstract class Block extends Directive
34  {
35      protected String key;
36  
37      /**
38       * Return type of this directive.
39       */
40      public int getType()
41      {
42          return BLOCK;
43      }
44      
45  }