InvalidPathException

AI-generated Key Takeaways

• InvalidPathException is an unchecked exception indicating a path string cannot be converted to a Path object due to invalid characters or file system constraints.

• It provides constructors to create instances with the invalid path string, reason for failure, and optionally the error index.

• Methods like getIndex, getInput, getReason, and getMessage offer details about the exception.

• Inherits methods from IllegalArgumentException, Throwable, and Object for exception handling and object manipulation.

public class InvalidPathException extends IllegalArgumentException

Unchecked exception thrown when path string cannot be converted into a Path because the path string contains invalid characters, or the path string is invalid for other file system specific reasons.

Public Constructor Summary

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

Public Method Summary

int	getIndex() Returns an index into the input string of the position at which the error occurred, or -1 if this position is not known.
String	getInput() Returns the input string.
String	getMessage() Returns a string describing the error.
String	getReason() Returns a string explaining why the input string was rejected.

Inherited Method Summary

From class java.lang.Throwable

synchronized final void	addSuppressed(Throwable exception) Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
synchronized Throwable	fillInStackTrace() Fills in the execution stack trace.
synchronized Throwable	getCause() Returns the cause of this throwable or null if the cause is nonexistent or unknown.
String	getLocalizedMessage() Creates a localized description of this throwable.
String	getMessage() Returns the detail message string of this throwable.
StackTraceElement[]	getStackTrace() Provides programmatic access to the stack trace information printed by printStackTrace().
synchronized final Throwable[]	getSuppressed() Returns an array containing all of the exceptions that were suppressed, typically by the try-with-resources statement, in order to deliver this exception.
synchronized Throwable	initCause(Throwable cause) Initializes the cause of this throwable to the specified value.
void	printStackTrace() Prints this throwable and its backtrace to the standard error stream.
void	printStackTrace(PrintWriter s) Prints this throwable and its backtrace to the specified print writer.
void	printStackTrace(PrintStream s) Prints this throwable and its backtrace to the specified print stream.
void	setStackTrace(StackTraceElement[] stackTrace) Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods.
String	toString() Returns a short description of this throwable.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public InvalidPathException (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 was rejected
index	the index at which the 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

public InvalidPathException (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 was rejected

Throws

NullPointerException	if either the input or reason strings are null

Public Methods

public int getIndex ()

Returns an index into the input string of the position at which the error occurred, or -1 if this position is not known.

Returns

• the error index

public String getInput ()

Returns the input string.

Returns

• the input string

public String getMessage ()

Returns a string describing the 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.

Returns

• a string describing the error

public String getReason ()

Returns a string explaining why the input string was rejected.

Returns

• the reason string