Source for javax.swing.text.BadLocationException

   1: /* BadLocationException.java --
   2:    Copyright (C) 2002, 2004, 2005  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.swing.text;
  39: 
  40: /**
  41:  * Indicates that an invalid location within a <code>Document</code> has been
  42:  * accessed.
  43:  *
  44:  * @author original author unknown
  45:  * @author Roman Kennke (roman@kennke.org)
  46:  */
  47: public class BadLocationException extends Exception
  48: {
  49:   /** The serial version UID for BadLocationException. */
  50:   private static final long serialVersionUID = -7712259886815656766L;
  51: 
  52:   /**
  53:    * The invalid location.
  54:    */
  55:   int offset;
  56: 
  57:   /**
  58:    * Constructs a <code>BadLocationException</code>
  59:    *
  60:    * @param str a string indicating what was wrong with the arguments
  61:    * @param offset offset within the document that was requested &gt;= 0
  62:    */
  63:   public BadLocationException(String str, int offset)
  64:   {
  65:     super(str);
  66:     this.offset = offset;
  67:   }
  68: 
  69:   /**
  70:    * Returns the offset into the document that was not legal.
  71:    *
  72:    * @return the offset into the document that was not legal
  73:    */
  74:   public int offsetRequested()
  75:   {
  76:     return offset;
  77:   }
  78: }