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   * A very simple directive that leverages the Node.literal()
24   * to grab the literal rendition of a node. We basically
25   * grab the literal value on init(), then repeatedly use
26   * that during render().  <em>This is deprecated and will be
27   * removed in Velocity 2.0; please use #[[unparsed content]]#
28   * instead.</em>
29   *
30   * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
31   * @version $Id: Literal.java 746438 2009-02-21 05:41:24Z nbubna $
32   * @deprecated Use the #[[unparsed content]]# syntax instead.
33   */
34  public class Literal extends Directive
35  {
36      String literalText;
37  
38      /**
39       * Return name of this directive.
40       * @return The name of this directive.
41       */
42      public String getName()
43      {
44          return "literal";
45      }
46  
47      /**
48       * Return type of this directive.
49       * @return The type of this directive.
50       */
51      public int getType()
52      {
53          return BLOCK;
54      }
55  
56      /**
57       * Since there is no processing of content,
58       * there is never a need for an internal scope.
59       */
60      public boolean isScopeProvided()
61      {
62          return false;
63      }
64  
65  }