View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.jxr.util;
20  
21  /**
22   * A StringEntry represents a value found by the tokenizer. The index is where
23   * this StringEntry was found in the source string.
24   */
25  public final class StringEntry {
26      private final String value;
27  
28      private final int index;
29  
30      /**
31       * Constructor.
32       *
33       * @param value value
34       * @param index index
35       */
36      public StringEntry(String value, int index) {
37          this.value = value;
38          this.index = index;
39      }
40  
41      /**
42       * Gets the index attribute of the StringEntry object.
43       *
44       * @return index
45       */
46      public int getIndex() {
47          return this.index;
48      }
49  
50      @Override
51      public String toString() {
52          return this.value;
53      }
54  }