View Javadoc

1   package org.apache.velocity.app.event.implement;
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 org.apache.velocity.util.introspection.Info;
23  
24  /**
25   * Convenience class to use when reporting out invalid syntax 
26   * with line, column, and template name.
27   * 
28   * @author <a href="mailto:wglass@forio.com">Will Glass-Husain </a>
29   * @version $Id: InvalidReferenceInfo.java 470256 2006-11-02 07:20:36Z wglass $
30   */
31  public class InvalidReferenceInfo extends Info
32  {
33      private String invalidReference;
34      
35      public InvalidReferenceInfo(String invalidReference, Info info)
36      {
37          super(info.getTemplateName(),info.getLine(),info.getColumn());
38          this.invalidReference = invalidReference; 
39      }
40  
41      /**
42       * Get the specific invalid reference string.
43       * @return the invalid reference string
44       */
45      public String getInvalidReference()
46      {
47          return invalidReference;
48      }
49      
50      
51  
52      /**
53       * Formats a textual representation of this object as <code>SOURCE
54       * [line X, column Y]: invalidReference</code>.
55       *
56       * @return String representing this object.
57       */
58      public String toString()
59      {
60          return getTemplateName() + " [line " + getLine() + ", column " +
61              getColumn() + "]: " + invalidReference;
62      }
63  }