View Javadoc

1   /***
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Exoffice Technologies.  For written permission,
18   *    please contact info@exolab.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Exoffice Technologies. Exolab is a registered
23   *    trademark of Exoffice Technologies.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.exolab.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 2000-2001,2003 (C) Exoffice Technologies Inc. All Rights Reserved.
42   */
43  
44  package org.exolab.jms.selector;
45  
46  
47  /***
48   * This class encapsulates the context of a parsed token.
49   *
50   * @version     $Revision: 1.1 $ $Date: 2004/11/26 01:50:44 $
51   * @author      <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
52   * @see         SelectorException
53   * @see         org.exolab.jms.selector.parser.SelectorAST
54   */
55  public final class Context {
56  
57      /***
58       * The line of the parsed token
59       */
60      private final int _line;
61  
62      /***
63       * The column of the parsed token
64       */
65      private final int _column;
66  
67  
68      /***
69       * Construct a new <code>Context</code>
70       *
71       * @param line the line where the token was encountered
72       * @param column the column where the token was encountered
73       */
74      public Context(final int line, final int column) {
75          _line = line;
76          _column = column;
77      }
78  
79      /***
80       * Returns the line where the token was encountered
81       *
82       * @return the line number
83       */
84      public int getLine() {
85          return _line;
86      }
87  
88      /***
89       * Returns the column where the token was encountered
90       *
91       * @return the column number
92       */
93      public int getColumn() {
94          return _column;
95      }
96  
97      /***
98       * Returns a string representation of this
99       *
100      * @return a string representation of this
101      */
102     public String toString() {
103         return "line " + _line + ", column " + _column;
104     }
105 
106 } //-- Context