2009/05/20 - Apache Shale has been retired.

For more information, please explore the Attic.


1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  /*
19   * $Id: Token.java 464373 2006-10-16 04:21:54Z rahul $
20   */
21  package org.apache.shale.clay.parser;
22  
23  /***
24   * <p>A <code>Token</code> identifies an offset range
25   * within the document.  Nodes and Attributes implementing
26   * this interface are identified by the {@link NodeTokenizer} and
27   * {@link AttributeTokenizer}.
28   * </p>
29   */
30  public interface Token {
31  
32      /***
33       * <p>Beginning offset of the token within the document.</p>
34       *
35       * @return beginning offset
36       */
37      int getBeginOffset();
38  
39      /***
40       * <p>Ending offset of the token within the document.</p>
41       *
42       * @return ending offset
43       */
44      int getEndOffset();
45  
46      /***
47       * <p>The complete identifier within the document defined
48       * by the range between the <code>beginOffset</code> and
49       * <code>endOffset</code>.
50       * </p>
51       *
52       * @return text between offset ranges
53       */
54      String getRawText();
55  
56      /***
57       * <p>Returns a reference to the complete document.</p>
58       *
59       * @return parsed document
60       */
61      StringBuffer getDocument();
62  
63      /***
64       * <p>Returns the line number in the document that the node starts.</p>
65       *
66       * @return line number the token is find on
67       */
68      int getLineNumber();
69  
70      /***
71       * <p>Returns the line begining offset in the document that the node starts.</p>
72       *
73       * @return line offset the token is found on
74       */
75      int getLineBeginOffset();
76  
77  }