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