View Javadoc

1   package org.apache.velocity.runtime.parser.node;
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  import java.io.IOException;
23  import java.io.Writer;
24  
25  import org.apache.velocity.context.InternalContextAdapter;
26  import org.apache.velocity.exception.MethodInvocationException;
27  import org.apache.velocity.exception.ParseErrorException;
28  import org.apache.velocity.exception.ResourceNotFoundException;
29  import org.apache.velocity.runtime.parser.Parser;
30  import org.apache.velocity.runtime.parser.Token;
31  
32  /**
33   *  Represents all comments...
34   *
35   *  @author <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>
36   *  @version $Id: ASTComment.java 517553 2007-03-13 06:09:58Z wglass $
37   */
38  public class ASTComment extends SimpleNode
39  {
40      private static final char[] ZILCH = "".toCharArray();
41  
42      private char[] carr;
43  
44      /**
45       * @param id
46       */
47      public ASTComment(int id)
48      {
49          super(id);
50      }
51  
52      /**
53       * @param p
54       * @param id
55       */
56      public ASTComment(Parser p, int id)
57      {
58          super(p, id);
59      }
60  
61      /**
62       * @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.node.ParserVisitor, java.lang.Object)
63       */
64      public Object jjtAccept(ParserVisitor visitor, Object data)
65      {
66          return visitor.visit(this, data);
67      }
68  
69      /**
70       *  We need to make sure we catch any of the dreaded MORE tokens.
71       * @param context
72       * @param data
73       * @return The data object.
74       */
75      public Object init(InternalContextAdapter context, Object data)
76      {
77          Token t = getFirstToken();
78  
79          int loc1 = t.image.indexOf("##");
80          int loc2 = t.image.indexOf("#*");
81  
82          if (loc1 == -1 && loc2 == -1)
83          {
84              carr = ZILCH;
85          }
86          else
87          {
88              carr = t.image.substring(0, (loc1 == -1) ? loc2 : loc1).toCharArray();
89          }
90  
91          return data;
92      }
93  
94      /**
95       * @see org.apache.velocity.runtime.parser.node.SimpleNode#render(org.apache.velocity.context.InternalContextAdapter, java.io.Writer)
96       */
97      public boolean render( InternalContextAdapter context, Writer writer)
98          throws IOException, MethodInvocationException, ParseErrorException, ResourceNotFoundException
99      {
100 
101         if (context.getAllowRendering())
102         {
103             writer.write(carr);
104         }
105 
106         return true;
107     }
108 
109 }