InvalidPathException

public class InvalidPathException
extends IllegalArgumentException

java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ java.lang.RuntimeException
         ↳ java.lang.IllegalArgumentException
           ↳ java.nio.file.InvalidPathException


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.

Summary

Public constructors

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.

Public methods

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 methods

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.

String getMessage()

Returns the detail message string of this throwable.

StackTraceElement[] getStackTrace()

Provides programmatic access to the stack trace information printed by 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(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.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the 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.

String toString()

Returns a string representation of the object.

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.

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()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

InvalidPathException

Added in API level 26
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 String: the input string

reason String: a string explaining why the input was rejected

Throws
NullPointerException if either the input or reason strings are null

InvalidPathException

Added in API level 26
public InvalidPathException (String input, 
                String reason, 
                int index)

Constructs an instance from the given input string, reason, and error index.

Parameters
input String: the input string

reason String: a string explaining why the input was rejected

index int: 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 methods

getIndex

Added in API level 26
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
int the error index

getInput

Added in API level 26
public String getInput ()

Returns the input string.

Returns
String the input string

getMessage

Added in API level 26
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
String a string describing the error

getReason

Added in API level 26
public String getReason ()

Returns a string explaining why the input string was rejected.

Returns
String the reason string