01 /*
02 * Copyright 1997-2001 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25 package javax.swing.text;
26
27 /**
28 * This exception is to report bad locations within a document model
29 * (that is, attempts to reference a location that doesn't exist).
30 * <p>
31 * <strong>Warning:</strong>
32 * Serialized objects of this class will not be compatible with
33 * future Swing releases. The current serialization support is
34 * appropriate for short term storage or RMI between applications running
35 * the same version of Swing. As of 1.4, support for long term storage
36 * of all JavaBeans<sup><font size="-2">TM</font></sup>
37 * has been added to the <code>java.beans</code> package.
38 * Please see {@link java.beans.XMLEncoder}.
39 *
40 * @author Timothy Prinzing
41 * @version 1.27 05/05/07
42 */
43 public class BadLocationException extends Exception {
44 /**
45 * Creates a new BadLocationException object.
46 *
47 * @param s a string indicating what was wrong with the arguments
48 * @param offs offset within the document that was requested >= 0
49 */
50 public BadLocationException(String s, int offs) {
51 super (s);
52 this .offs = offs;
53 }
54
55 /**
56 * Returns the offset into the document that was not legal.
57 *
58 * @return the offset >= 0
59 */
60 public int offsetRequested() {
61 return offs;
62 }
63
64 private int offs;
65 }
|