001 /* URISyntaxException.java -- a string could not be parsed as a URI
002 Copyright (C) 2002 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038 package java.net;
039
040
041 /**
042 * This exception is thrown when a String cannot be parsed as a URI.
043 *
044 * @author Eric Blake (ebb9@email.byu.edu)
045 * @see URI
046 * @since 1.4
047 * @status updated to 1.4
048 */
049 public class URISyntaxException extends Exception
050 {
051 /**
052 * Compatible with JDK 1.4+.
053 */
054 private static final long serialVersionUID = 2137979680897488891L;
055
056 /**
057 * The failed input.
058 *
059 * @serial the bad URI
060 */
061 private final String input;
062
063 /**
064 * The index of failure.
065 *
066 * @serial the location of the problem
067 */
068 private final int index;
069
070 /**
071 * Create an exception from the invalid string, with the index set to -1.
072 *
073 * @param input the bad URI
074 * @param msg the descriptive error message
075 * @throws NullPointerException if input or msg are null
076 */
077 public URISyntaxException(String input, String msg)
078 {
079 this(input, msg, -1);
080 }
081
082 /**
083 * Create an exception from the invalid string, with the index of the
084 * point of failure.
085 *
086 * @param input the bad URI
087 * @param msg the descriptive error message
088 * @param index the index of the parse error, or -1
089 * @throws NullPointerException if input or msg are null
090 * @throws IllegalArgumentException if index < -1
091 */
092 public URISyntaxException(String input, String msg, int index)
093 {
094 // The toString() hack checks for null.
095 super(msg.toString());
096 this.input = input.toString();
097 this.index = index;
098 if (index < -1)
099 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() >= 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 }