libjava/java/net/URISyntaxException.java

   1 /* URISyntaxException.java -- a string could not be parsed as a URI
   2    Copyright (C) 2002 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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 java.net;
  39
  40
  41 /**
  42  * This exception is thrown when a String cannot be parsed as a URI.
  43  *
  44  * @author Eric Blake (ebb9@email.byu.edu)
  45  * @see URI
  46  * @since 1.4
  47  * @status updated to 1.4
  48  */
  49 public class URISyntaxException extends Exception
  50 {
  51   /**
  52    * Compatible with JDK 1.4+.
  53    */
  54   private static final long serialVersionUID = 2137979680897488891L;
  55
  56   /**
  57    * The failed input.
  58    *
  59    * @serial the bad URI
  60    */
  61   private final String input;
  62
  63   /**
  64    * The index of failure.
  65    *
  66    * @serial the location of the problem
  67    */
  68   private final int index;
  69
  70   /**
  71    * Create an exception from the invalid string, with the index set to -1.
  72    *
  73    * @param input the bad URI
  74    * @param msg the descriptive error message
  75    * @throws NullPointerException if input or msg are null
  76    */
  77   public URISyntaxException(String input, String msg)
  78   {
  79     this(input, msg, -1);
  80   }
  81
  82   /**
  83    * Create an exception from the invalid string, with the index of the
  84    * point of failure.
  85    *
  86    * @param input the bad URI
  87    * @param msg the descriptive error message
  88    * @param index the index of the parse error, or -1
  89    * @throws NullPointerException if input or msg are null
  90    * @throws IllegalArgumentException if index &lt; -1
  91    */
  92   public URISyntaxException(String input, String msg, int index)
  93   {
  94     // The toString() hack checks for null.
  95     super(msg.toString());
  96     this.input = input.toString();
  97     this.index = index;
  98     if (index < -1)
  99       throw new IllegalArgumentException();
 100   }
 101
 102   /**
 103    * Returns the bad input string.
 104    *
 105    * @return the bad URI, guaranteed non-null
 106    */
 107   public String getInput()
 108   {
 109     return input;
 110   }
 111
 112   /**
 113    * Returns the reason for the failure.
 114    *
 115    * @return the message, guaranteed non-null
 116    */
 117   public String getReason()
 118   {
 119     return super.getMessage();
 120   }
 121
 122   /**
 123    * Returns the index of the failure, or -1.
 124    *
 125    * @return the index of failure
 126    */
 127   public int getIndex()
 128   {
 129     return index;
 130   }
 131
 132   /**
 133    * Returns a message describing the parse error, as if by
 134    * <code>getReason() + (getIndex() &gt;= 0 ? " at index " + getIndex() : "")
 135    * + ": " + getInput()</code>.
 136    *
 137    * @return the message string
 138    */
 139   public String getMessage()
 140   {
 141     return (super.getMessage() + (index >= 0 ? " at index " + index : "")
 142            + ": " + input);
 143   }
 144 }