Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/java/nio/file/InvalidPathException#pubctors) \| [Methods](https://developer.android.com/reference/java/nio/file/InvalidPathException#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/java/nio/file/InvalidPathException#inhmethods)

# InvalidPathException

` public class InvalidPathException `   
` ` ` ` ` ` ` ` ` extends https://developer.android.com/reference/java/lang/IllegalArgumentException ` ` `

|---|---|---|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||||||
| ↳ | [java.lang.Throwable](https://developer.android.com/reference/java/lang/Throwable) |||||
|   | ↳ | [java.lang.Exception](https://developer.android.com/reference/java/lang/Exception) ||||
|   |   | ↳ | [java.lang.RuntimeException](https://developer.android.com/reference/java/lang/RuntimeException) |||
|   |   |   | ↳ | [java.lang.IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) ||
|   |   |   |   | ↳ | java.nio.file.InvalidPathException |

<br />

*** ** * ** ***

Unchecked exception thrown when path string cannot be converted into a `https://developer.android.com/reference/java/nio/file/Path` because the path string contains invalid characters, or the path string is invalid for other file system specific reasons.

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/java/nio/file/InvalidPathException#InvalidPathException(java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String input, https://developer.android.com/reference/java/lang/String reason) ` Constructs an instance from the given input string and reason. |
| ` https://developer.android.com/reference/java/nio/file/InvalidPathException#InvalidPathException(java.lang.String,%20java.lang.String,%20int)(https://developer.android.com/reference/java/lang/String input, https://developer.android.com/reference/java/lang/String reason, int index) ` Constructs an instance from the given input string, reason, and error index. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/java/nio/file/InvalidPathException#getIndex()() ` Returns an index into the input string of the position at which the error occurred, or `-1` if this position is not known. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/nio/file/InvalidPathException#getInput()() ` Returns the input string. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/nio/file/InvalidPathException#getMessage()() ` Returns a string describing the error. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/nio/file/InvalidPathException#getReason()() ` Returns a string explaining why the input string was rejected. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Throwable ` ` final void` ` https://developer.android.com/reference/java/lang/Throwable#addSuppressed(java.lang.Throwable)(https://developer.android.com/reference/java/lang/Throwable exception) `

Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
` https://developer.android.com/reference/java/lang/Throwable` ` https://developer.android.com/reference/java/lang/Throwable#fillInStackTrace()() `

Fills in the execution stack trace.
` https://developer.android.com/reference/java/lang/Throwable` ` https://developer.android.com/reference/java/lang/Throwable#getCause()() `

Returns the cause of this throwable or `null` if the cause is nonexistent or unknown.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Throwable#getLocalizedMessage()() `

Creates a localized description of this throwable.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Throwable#getMessage()() `

Returns the detail message string of this throwable.
` https://developer.android.com/reference/java/lang/StackTraceElement` ` https://developer.android.com/reference/java/lang/Throwable#getStackTrace()() `

Provides programmatic access to the stack trace information printed by `https://developer.android.com/reference/java/lang/Throwable#printStackTrace()`.
` final https://developer.android.com/reference/java/lang/Throwable` ` https://developer.android.com/reference/java/lang/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.
` https://developer.android.com/reference/java/lang/Throwable` ` https://developer.android.com/reference/java/lang/Throwable#initCause(java.lang.Throwable)(https://developer.android.com/reference/java/lang/Throwable cause) `

Initializes the *cause* of this throwable to the specified value.
` void` ` https://developer.android.com/reference/java/lang/Throwable#printStackTrace()() `

Prints this throwable and its backtrace to the standard error stream.
` void` ` https://developer.android.com/reference/java/lang/Throwable#printStackTrace(java.io.PrintWriter)(https://developer.android.com/reference/java/io/PrintWriter s) `

Prints this throwable and its backtrace to the specified print writer.
` void` ` https://developer.android.com/reference/java/lang/Throwable#printStackTrace(java.io.PrintStream)(https://developer.android.com/reference/java/io/PrintStream s) `

Prints this throwable and its backtrace to the specified print stream.
` void` ` https://developer.android.com/reference/java/lang/Throwable#setStackTrace(java.lang.StackTraceElement[])(https://developer.android.com/reference/java/lang/StackTraceElement stackTrace) `

Sets the stack trace elements that will be returned by `https://developer.android.com/reference/java/lang/Throwable#getStackTrace()` and printed by `https://developer.android.com/reference/java/lang/Throwable#printStackTrace()` and related methods.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Throwable#toString()() `

Returns a short description of this throwable.
From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Parameters ||
|---|---|
| `input` | `String`: the input string <br /> |
| `reason` | `String`: a string explaining why the input was rejected <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if either the input or reason strings are `null` |

### InvalidPathException

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public InvalidPathException (String input, 
                String reason, 
                int index)
```

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

<br />

| Parameters ||
|---|---|
| `input` | `String`: the input string <br /> |
| `reason` | `String`: a string explaining why the input was rejected <br /> |
| `index` | `int`: the index at which the error occurred, or `-1` if the index is not known <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the error index is less than `-1` |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if either the input or reason strings are `null` |

## Public methods

### getIndex

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Returns ||
|---|---|
| `int` | the error index <br /> |

### getInput

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getInput ()
```

Returns the input string.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the input string <br /> |

### getMessage

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string describing the error <br /> |

### getReason

Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getReason ()
```

Returns a string explaining why the input string was rejected.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the reason string <br /> |