1 package org.apache.maven.jxr.util;
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 /**
23 * A StringEntry represents a value found by the tokenizer. The index is where
24 * this StringEntry was found in the source string
25 */
26 public final class StringEntry
27 {
28 private final String value;
29
30 private final int index;
31
32 /**
33 * Constructor for the StringEntry object
34 *
35 * @param value
36 * @param index
37 */
38 public StringEntry( String value, int index )
39 {
40
41 this.value = value;
42 this.index = index;
43 }
44
45 /**
46 * Gets the index attribute of the StringEntry object
47 */
48 public int getIndex()
49 {
50 return this.index;
51 }
52
53 /**
54 * Description of the Method
55 */
56 @Override
57 public String toString()
58 {
59 return this.value;
60 }
61 }
62