ParseException.java revision b272dc3a96c819d5709de9de11e800d87f7a42fc
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
18package java.text;
19
20/**
21 * Thrown when the string being parsed is not in the correct form.
22 */
23public class ParseException extends Exception {
24
25    private static final long serialVersionUID = 2703218443322787634L;
26
27    private int errorOffset;
28
29    /**
30     * Constructs a new instance of this class with its stack trace, detail
31     * message and the location of the error filled in.
32     *
33     * @param detailMessage
34     *            the detail message for this exception.
35     * @param location
36     *            the index at which the parse exception occurred.
37     */
38    public ParseException(String detailMessage, int location) {
39        super(detailMessage + (" (at offset " + location + ")"));
40        errorOffset = location;
41    }
42
43    /**
44     * Returns the index at which this parse exception occurred.
45     *
46     * @return the location of this exception in the parsed string.
47     */
48    public int getErrorOffset() {
49        return errorOffset;
50    }
51}
52