Module java.base

Package java.nio.file

Class InvalidPathException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

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.

See Also:

Serialized Form

Constructor Summary

Constructors

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 inherited from class java.lang.Object

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

Methods inherited from class java.lang.Throwable

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

Constructor Detail

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