JavaTM 2 Platform
Standard Ed. 5.0

java.net
Class URISyntaxException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.net.URISyntaxException
All Implemented Interfaces:
Serializable

public class URISyntaxException
extends Exception

Checked exception thrown to indicate that a string could not be parsed as a URI reference.

See Also:
URI, Serialized Form

Constructor Summary
URISyntaxException(String input, String reason)
          Constructs an instance from the given input string and reason.
URISyntaxException(String input, String reason, int index)
          Constructs an instance from the given input string, reason, and error index.
 
Method Summary
 int getIndex()
          Returns an index into the input string of the position at which the parse error occurred, or -1 if this position is not known.
 String getInput()
          Returns the input string.
 String getMessage()
          Returns a string describing the parse error.
 String getReason()
          Returns a string explaining why the input string could not be parsed.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

URISyntaxException

public URISyntaxException(String input,
                          String reason,
                          int index)
Constructs an instance from the given input string, reason, and error index.

Parameters:
input - The input string
reason - A string explaining why the input could not be parsed
index - The index at which the parse error occurred, or -1 if the index is not known
Throws:
NullPointerException - If either the input or reason strings are null
IllegalArgumentException - If the error index is less than -1

URISyntaxException

public URISyntaxException(String input,
                          String reason)
Constructs an instance from the given input string and reason. The resulting object will have an error index of -1.

Parameters:
input - The input string
reason - A string explaining why the input could not be parsed
Throws:
NullPointerException - If either the input or reason strings are null
Method Detail

getInput

public String getInput()
Returns the input string.

Returns:
The input string

getReason

public String getReason()
Returns a string explaining why the input string could not be parsed.

Returns:
The reason string

getIndex

public int getIndex()
Returns an index into the input string of the position at which the parse error occurred, or -1 if this position is not known.

Returns:
The error index

getMessage

public String getMessage()
Returns a string describing the parse error. The resulting string consists of the reason string followed by a colon character (':'), a space, and the input string. If the error index is defined then the string " at index " followed by the index, in decimal, is inserted after the reason string and before the colon character.

Overrides:
getMessage in class Throwable
Returns:
A string describing the parse error

JavaTM 2 Platform
Standard Ed. 5.0

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.