author | naoto |
Tue, 15 Oct 2019 09:25:59 -0700 | |
changeset 58603 | 2312d1a04c49 |
parent 58288 | 48e480e56aad |
permissions | -rw-r--r-- |
2 | 1 |
/* |
58288
48e480e56aad
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents:
47216
diff
changeset
|
2 |
* Copyright (c) 1996, 2019, Oracle and/or its affiliates. All rights reserved. |
2 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
2 | 24 |
*/ |
25 |
||
26 |
/* |
|
27 |
* (C) Copyright Taligent, Inc. 1996, 1997 - All Rights Reserved |
|
28 |
* (C) Copyright IBM Corp. 1996 - 1998 - All Rights Reserved |
|
29 |
* |
|
30 |
* The original version of this source code and documentation is copyrighted |
|
31 |
* and owned by Taligent, Inc., a wholly-owned subsidiary of IBM. These |
|
32 |
* materials are provided under terms of a License Agreement between Taligent |
|
33 |
* and Sun. This technology is protected by multiple US and International |
|
34 |
* patents. This notice and attribution to Taligent may not be removed. |
|
35 |
* Taligent is a registered trademark of Taligent, Inc. |
|
36 |
* |
|
37 |
*/ |
|
38 |
||
39 |
package java.text; |
|
40 |
||
41 |
||
42 |
/** |
|
58288
48e480e56aad
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents:
47216
diff
changeset
|
43 |
* {@code ParsePosition} is a simple class used by {@code Format} |
2 | 44 |
* and its subclasses to keep track of the current position during parsing. |
58288
48e480e56aad
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents:
47216
diff
changeset
|
45 |
* The {@code parseObject} method in the various {@code Format} |
48e480e56aad
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents:
47216
diff
changeset
|
46 |
* classes requires a {@code ParsePosition} object as an argument. |
2 | 47 |
* |
48 |
* <p> |
|
49 |
* By design, as you parse through a string with different formats, |
|
58288
48e480e56aad
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents:
47216
diff
changeset
|
50 |
* you can use the same {@code ParsePosition}, since the index parameter |
2 | 51 |
* records the current position. |
52 |
* |
|
53 |
* @author Mark Davis |
|
45434
4582657c7260
8181082: class-level since tag issues in java.base & java.datatransfer module
mli
parents:
25859
diff
changeset
|
54 |
* @since 1.1 |
2 | 55 |
* @see java.text.Format |
56 |
*/ |
|
57 |
||
58 |
public class ParsePosition { |
|
59 |
||
60 |
/** |
|
61 |
* Input: the place you start parsing. |
|
62 |
* <br>Output: position where the parse stopped. |
|
63 |
* This is designed to be used serially, |
|
64 |
* with each call setting index up for the next one. |
|
65 |
*/ |
|
66 |
int index = 0; |
|
67 |
int errorIndex = -1; |
|
68 |
||
69 |
/** |
|
70 |
* Retrieve the current parse position. On input to a parse method, this |
|
71 |
* is the index of the character at which parsing will begin; on output, it |
|
72 |
* is the index of the character following the last character parsed. |
|
19054
a64012cb49d6
8021108: Clean up doclint warnings and errors in java.text package
peytoia
parents:
5506
diff
changeset
|
73 |
* |
a64012cb49d6
8021108: Clean up doclint warnings and errors in java.text package
peytoia
parents:
5506
diff
changeset
|
74 |
* @return the current parse position |
2 | 75 |
*/ |
76 |
public int getIndex() { |
|
77 |
return index; |
|
78 |
} |
|
79 |
||
80 |
/** |
|
81 |
* Set the current parse position. |
|
19054
a64012cb49d6
8021108: Clean up doclint warnings and errors in java.text package
peytoia
parents:
5506
diff
changeset
|
82 |
* |
a64012cb49d6
8021108: Clean up doclint warnings and errors in java.text package
peytoia
parents:
5506
diff
changeset
|
83 |
* @param index the current parse position |
2 | 84 |
*/ |
85 |
public void setIndex(int index) { |
|
86 |
this.index = index; |
|
87 |
} |
|
88 |
||
89 |
/** |
|
90 |
* Create a new ParsePosition with the given initial index. |
|
19054
a64012cb49d6
8021108: Clean up doclint warnings and errors in java.text package
peytoia
parents:
5506
diff
changeset
|
91 |
* |
a64012cb49d6
8021108: Clean up doclint warnings and errors in java.text package
peytoia
parents:
5506
diff
changeset
|
92 |
* @param index initial index |
2 | 93 |
*/ |
94 |
public ParsePosition(int index) { |
|
95 |
this.index = index; |
|
96 |
} |
|
97 |
/** |
|
98 |
* Set the index at which a parse error occurred. Formatters |
|
99 |
* should set this before returning an error code from their |
|
100 |
* parseObject method. The default value is -1 if this is not set. |
|
19054
a64012cb49d6
8021108: Clean up doclint warnings and errors in java.text package
peytoia
parents:
5506
diff
changeset
|
101 |
* |
a64012cb49d6
8021108: Clean up doclint warnings and errors in java.text package
peytoia
parents:
5506
diff
changeset
|
102 |
* @param ei the index at which an error occurred |
2 | 103 |
* @since 1.2 |
104 |
*/ |
|
105 |
public void setErrorIndex(int ei) |
|
106 |
{ |
|
107 |
errorIndex = ei; |
|
108 |
} |
|
109 |
||
110 |
/** |
|
111 |
* Retrieve the index at which an error occurred, or -1 if the |
|
112 |
* error index has not been set. |
|
19054
a64012cb49d6
8021108: Clean up doclint warnings and errors in java.text package
peytoia
parents:
5506
diff
changeset
|
113 |
* |
a64012cb49d6
8021108: Clean up doclint warnings and errors in java.text package
peytoia
parents:
5506
diff
changeset
|
114 |
* @return the index at which an error occurred |
2 | 115 |
* @since 1.2 |
116 |
*/ |
|
117 |
public int getErrorIndex() |
|
118 |
{ |
|
119 |
return errorIndex; |
|
120 |
} |
|
19054
a64012cb49d6
8021108: Clean up doclint warnings and errors in java.text package
peytoia
parents:
5506
diff
changeset
|
121 |
|
2 | 122 |
/** |
123 |
* Overrides equals |
|
124 |
*/ |
|
125 |
public boolean equals(Object obj) |
|
126 |
{ |
|
127 |
if (obj == null) return false; |
|
128 |
if (!(obj instanceof ParsePosition)) |
|
129 |
return false; |
|
130 |
ParsePosition other = (ParsePosition) obj; |
|
131 |
return (index == other.index && errorIndex == other.errorIndex); |
|
132 |
} |
|
133 |
||
134 |
/** |
|
135 |
* Returns a hash code for this ParsePosition. |
|
136 |
* @return a hash code value for this object |
|
137 |
*/ |
|
138 |
public int hashCode() { |
|
139 |
return (errorIndex << 16) | index; |
|
140 |
} |
|
141 |
||
142 |
/** |
|
143 |
* Return a string representation of this ParsePosition. |
|
144 |
* @return a string representation of this object |
|
145 |
*/ |
|
146 |
public String toString() { |
|
147 |
return getClass().getName() + |
|
148 |
"[index=" + index + |
|
149 |
",errorIndex=" + errorIndex + ']'; |
|
150 |
} |
|
151 |
} |