1 /*
2  * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
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
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
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  *
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.
24  */
25 
26 /*
27  *******************************************************************************
28  * Copyright (C) 2009-2010, International Business Machines Corporation and    *
29  * others. All Rights Reserved.                                                *
30  *******************************************************************************
31  */
32 
33 package java.util;
34 
35 /**
36  * Thrown by methods in {@link Locale} and {@link Locale.Builder} to
37  * indicate that an argument is not a well-formed BCP 47 tag.
38  *
39  * @see Locale
40  * @since 1.7
41  */
42 public class IllformedLocaleException extends RuntimeException {
43 
44     private static final long serialVersionUID = -5245986824925681401L;
45 
46     private int _errIdx = -1;
47 
48     /**
49      * Constructs a new <code>IllformedLocaleException</code> with no
50      * detail message and -1 as the error index.
51      */
IllformedLocaleException()52     public IllformedLocaleException() {
53         super();
54     }
55 
56     /**
57      * Constructs a new <code>IllformedLocaleException</code> with the
58      * given message and -1 as the error index.
59      *
60      * @param message the message
61      */
IllformedLocaleException(String message)62     public IllformedLocaleException(String message) {
63         super(message);
64     }
65 
66     /**
67      * Constructs a new <code>IllformedLocaleException</code> with the
68      * given message and the error index.  The error index is the approximate
69      * offset from the start of the ill-formed value to the point where the
70      * parse first detected an error.  A negative error index value indicates
71      * either the error index is not applicable or unknown.
72      *
73      * @param message the message
74      * @param errorIndex the index
75      */
IllformedLocaleException(String message, int errorIndex)76     public IllformedLocaleException(String message, int errorIndex) {
77         super(message + ((errorIndex < 0) ? "" : " [at index " + errorIndex + "]"));
78         _errIdx = errorIndex;
79     }
80 
81     /**
82      * Returns the index where the error was found. A negative value indicates
83      * either the error index is not applicable or unknown.
84      *
85      * @return the error index
86      */
getErrorIndex()87     public int getErrorIndex() {
88         return _errIdx;
89     }
90 }
91