Class InvalidPathException

java.nio.file.InvalidPathException

All Implemented Interfaces:: Serializable

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.

Since:

1.7

See Also:

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`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.

Methods declared in class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Modifier and Type	Method	Description
`final void`	`addSuppressed(Throwable exception)`	Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
`Throwable`	`fillInStackTrace()`	Fills in the execution stack trace.
`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.
`StackTraceElement[]`	`getStackTrace()`	Provides programmatic access to the stack trace information printed by `Throwable.printStackTrace()`.
`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.
`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(PrintStream s)`	Prints this throwable and its backtrace to the specified print stream.
`void`	`printStackTrace(PrintWriter s)`	Prints this throwable and its backtrace to the specified print writer.
`void`	`setStackTrace(StackTraceElement[] stackTrace)`	Sets the stack trace elements that will be returned by `Throwable.getStackTrace()` and printed by `Throwable.printStackTrace()` and related methods.
`String`	`toString()`	Returns a short description of this throwable.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

InvalidPathException

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

InvalidPathException

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

Method Details

getInput

public String getInput()

Returns the input string.

Returns:: the input string

getReason

public String getReason()

Returns a string explaining why the input string was rejected.

Returns:: the reason string

getIndex

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

getMessage

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.

Overrides:: getMessage in class Throwable
Returns:: a string describing the error

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.