# DocumentFile

Artifact: [androidx.documentfile:documentfile](https://developer.android.com/jetpack/androidx/releases/documentfile) [View Source](https://cs.android.com/search?q=file:androidx/documentfile/provider/DocumentFile.java+class:androidx.documentfile.provider.DocumentFile) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

*** ** * ** ***


```
public abstract class DocumentFile
```

<br />

*** ** * ** ***

Representation of a document backed by either a `https://developer.android.com/reference/android/provider/DocumentsProvider.html` or a raw file on disk. This is a utility class designed to emulate the traditional `https://developer.android.com/reference/java/io/File.html` interface. It offers a simplified view of a tree of documents, but it has substantial overhead. For optimal performance and a richer feature set, use the `https://developer.android.com/reference/android/provider/DocumentsContract.html` methods and constants directly.

There are several differences between documents and traditional files:

- Documents express their display name and MIME type as separate fields, instead of relying on file extensions. Some documents providers may still choose to append extensions to their display names, but that's an implementation detail.
- A single document may appear as the child of multiple directories, so it doesn't inherently know who its parent is. That is, documents don't have a strong notion of path. You can easily traverse a tree of documents from parent to child, but not from child to parent.
- Each document has a unique identifier within that provider. This identifier is an *opaque* implementation detail of the provider, and as such it must not be parsed.

Before using this class, first consider if you really need access to an entire subtree of documents. The principle of least privilege dictates that you should only ask for access to documents you really need. If you only need the user to pick a single file, use `https://developer.android.com/reference/android/content/Intent.html#ACTION_OPEN_DOCUMENT` or `https://developer.android.com/reference/android/content/Intent.html#ACTION_GET_CONTENT`. If you want to let the user pick multiple files, add `https://developer.android.com/reference/android/content/Intent.html#EXTRA_ALLOW_MULTIPLE`. If you only need the user to save a single file, use `https://developer.android.com/reference/android/content/Intent.html#ACTION_CREATE_DOCUMENT`. If you use these APIs, you can pass the resulting `https://developer.android.com/reference/android/content/Intent.html#getData()` into `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#fromSingleUri(android.content.Context,android.net.Uri)` to work with that document.

If you really do need full access to an entire subtree of documents, start by launching `https://developer.android.com/reference/android/content/Intent.html#ACTION_OPEN_DOCUMENT_TREE` to let the user pick a directory. Then pass the resulting `https://developer.android.com/reference/android/content/Intent.html#getData()` into `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#fromTreeUri(android.content.Context,android.net.Uri)` to start working with the user selected tree.

As you navigate the tree of DocumentFile instances, you can always use `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#getUri()` to obtain the Uri representing the underlying document for that object, for use with `https://developer.android.com/reference/android/content/ContentResolver.html#openInputStream(android.net.Uri)`, etc.

To simplify your code on devices running `https://developer.android.com/reference/android/os/Build.VERSION_CODES.html#KITKAT` or earlier, you can use `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#fromFile(java.io.File)` which emulates the behavior of a `https://developer.android.com/reference/android/provider/DocumentsProvider.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsProvider.html` |   |
| `https://developer.android.com/reference/android/provider/DocumentsContract.html` |   |

## Summary

| ### Public methods |
|---|---|
| `abstract boolean` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#canRead()()` Indicates whether the current context is allowed to read from this file. |
| `abstract boolean` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#canWrite()()` Indicates whether the current context is allowed to write to this file. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#createDirectory(java.lang.String)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html displayName)` Create a new directory as a direct child of this directory. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#createFile(java.lang.String,java.lang.String)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html mimeType, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html displayName)` Create a new document as a direct child of this directory. |
| `abstract boolean` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#delete()()` Deletes this file. |
| `abstract boolean` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#exists()()` Returns a boolean indicating whether this file can be found. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#findFile(java.lang.String)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html displayName)` Search through `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#listFiles()` for the first document matching the given display name. |
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#fromFile(java.io.File)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/io/File.html file)` Create a `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` representing the filesystem tree rooted at the given `https://developer.android.com/reference/java/io/File.html`. |
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#fromSingleUri(android.content.Context,android.net.Uri)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/net/Uri.html singleUri)` Create a `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` representing the single document at the given `https://developer.android.com/reference/android/net/Uri.html`. |
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#fromTreeUri(android.content.Context,android.net.Uri)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/net/Uri.html treeUri)` Create a `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` representing the document tree rooted at the given `https://developer.android.com/reference/android/net/Uri.html`. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#getName()()` Return the display name of this document. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#getParentFile()()` Return the parent file of this document. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#getType()()` Return the MIME type of this document. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/net/Uri.html` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#getUri()()` Return a Uri for the underlying document represented by this file. |
| `abstract boolean` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#isDirectory()()` Indicates if this file represents a *directory*. |
| `static boolean` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#isDocumentUri(android.content.Context,android.net.Uri)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/net/Uri.html uri)` Test if given Uri is backed by a `https://developer.android.com/reference/android/provider/DocumentsProvider.html`. |
| `abstract boolean` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#isFile()()` Indicates if this file represents a *file*. |
| `abstract boolean` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#isVirtual()()` Indicates if this file represents a *virtual* document. |
| `abstract long` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#lastModified()()` Returns the time when this file was last modified, measured in milliseconds since January 1st, 1970, midnight. |
| `abstract long` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#length()()` Returns the length of this file in bytes. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html DocumentFile[]` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#listFiles()()` Returns an array of files contained in the directory represented by this file. |
| `abstract boolean` | `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#renameTo(java.lang.String)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html displayName)` Renames this file to `displayName`. |

## Public methods

### canRead

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract boolean canRead()
```

Indicates whether the current context is allowed to read from this file.

| Returns |
|---|---|
| `boolean` | `true` if this file can be read, `false` otherwise. |

### canWrite

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract boolean canWrite()
```

Indicates whether the current context is allowed to write to this file.

| Returns |
|---|---|
| `boolean` | `true` if this file can be written, `false` otherwise. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.Document.html#COLUMN_FLAGS` |   |
| `https://developer.android.com/reference/android/provider/DocumentsContract.Document.html#FLAG_SUPPORTS_DELETE` |   |
| `https://developer.android.com/reference/android/provider/DocumentsContract.Document.html#FLAG_SUPPORTS_WRITE` |   |
| `https://developer.android.com/reference/android/provider/DocumentsContract.Document.html#FLAG_DIR_SUPPORTS_CREATE` |   |

### createDirectory

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract @Nullable DocumentFile createDirectory(@NonNull String displayName)
```

Create a new directory as a direct child of this directory.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html displayName` | name of new directory |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` | file representing newly created directory, or null if failed |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException.html` | when working with a single document created from `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#fromSingleUri(android.content.Context,android.net.Uri)`. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.html#createDocument(android.content.ContentResolver, android.net.Uri, java.lang.String, java.lang.String)` |   |

### createFile

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract @Nullable DocumentFile createFile(@NonNull String mimeType, @NonNull String displayName)
```

Create a new document as a direct child of this directory.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html mimeType` | MIME type of new document, such as `image/png` or `audio/flac` |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html displayName` | name of new document, without any file extension appended; the underlying provider may choose to append the extension |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` | file representing newly created document, or null if failed |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException.html` | when working with a single document created from `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#fromSingleUri(android.content.Context,android.net.Uri)`. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.html#createDocument(android.content.ContentResolver, android.net.Uri, java.lang.String, java.lang.String)` |   |

### delete

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract boolean delete()
```

Deletes this file.

Note that this method does *not* throw `IOException` on failure. Callers must check the return value.

| Returns |
|---|---|
| `boolean` | `true` if this file was deleted, `false` otherwise. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.html#deleteDocument(android.content.ContentResolver, android.net.Uri)` |   |

### exists

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract boolean exists()
```

Returns a boolean indicating whether this file can be found.

| Returns |
|---|---|
| `boolean` | `true` if this file exists, `false` otherwise. |

### findFile

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public @Nullable DocumentFile findFile(@NonNull String displayName)
```

Search through `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#listFiles()` for the first document matching the given display name. Returns `null` when no matching document is found.

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException.html` | when working with a single document created from `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#fromSingleUri(android.content.Context,android.net.Uri)`. |

### fromFile

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public static @NonNull DocumentFile fromFile(@NonNull File file)
```

Create a `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` representing the filesystem tree rooted at the given `https://developer.android.com/reference/java/io/File.html`. This doesn't give you any additional access to the underlying files beyond what your app already has.

`https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#getUri()` will return `file://` Uris for files explored through this tree.

### fromSingleUri

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public static @Nullable DocumentFile fromSingleUri(@NonNull Context context, @NonNull Uri singleUri)
```

Create a `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` representing the single document at the given `https://developer.android.com/reference/android/net/Uri.html`. This is only useful on devices running `https://developer.android.com/reference/android/os/Build.VERSION_CODES.html#KITKAT` or later, and will return `null` when called on earlier platform versions.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context` | `https://developer.android.com/reference/android/content/Context.html` used to resolve resources |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/net/Uri.html singleUri` | the `https://developer.android.com/reference/android/content/Intent.html#getData()` from a successful `https://developer.android.com/reference/android/content/Intent.html#ACTION_OPEN_DOCUMENT` or `https://developer.android.com/reference/android/content/Intent.html#ACTION_CREATE_DOCUMENT` request. |

### fromTreeUri

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public static @Nullable DocumentFile fromTreeUri(@NonNull Context context, @NonNull Uri treeUri)
```

Create a `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile` representing the document tree rooted at the given `https://developer.android.com/reference/android/net/Uri.html`. This is only useful on devices running `https://developer.android.com/reference/android/os/Build.VERSION_CODES.html#LOLLIPOP` or later, and will return `null` when called on earlier platform versions.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context` | `https://developer.android.com/reference/android/content/Context.html` used to resolve resources |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/net/Uri.html treeUri` | the `https://developer.android.com/reference/android/content/Intent.html#getData()` from a successful `https://developer.android.com/reference/android/content/Intent.html#ACTION_OPEN_DOCUMENT_TREE` request. |

### getName

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract @Nullable String getName()
```

Return the display name of this document.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.Document.html#COLUMN_DISPLAY_NAME` |   |

### getParentFile

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public @Nullable DocumentFile getParentFile()
```

Return the parent file of this document. Only defined inside of the user-selected tree; you can never escape above the top of the tree.

The underlying `https://developer.android.com/reference/android/provider/DocumentsProvider.html` only defines a forward mapping from parent to child, so the reverse mapping of child to parent offered here is purely a convenience method, and it may be incorrect if the underlying tree structure changes.

### getType

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract @Nullable String getType()
```

Return the MIME type of this document.

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.Document.html#COLUMN_MIME_TYPE` |   |

### getUri

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract @NonNull Uri getUri()
```

Return a Uri for the underlying document represented by this file. This can be used with other platform APIs to manipulate or share the underlying content. You can use `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#isDocumentUri(android.content.Context,android.net.Uri)` to test if the returned Uri is backed by a `https://developer.android.com/reference/android/provider/DocumentsProvider.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/android/content/Intent.html#setData(android.net.Uri)` |   |
| `https://developer.android.com/reference/android/content/Intent.html#setClipData(android.content.ClipData)` |   |
| `https://developer.android.com/reference/android/content/ContentResolver.html#openInputStream(android.net.Uri)` |   |
| `https://developer.android.com/reference/android/content/ContentResolver.html#openOutputStream(android.net.Uri)` |   |
| `https://developer.android.com/reference/android/content/ContentResolver.html#openFileDescriptor(android.net.Uri, java.lang.String)` |   |

### isDirectory

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract boolean isDirectory()
```

Indicates if this file represents a *directory*.

| Returns |
|---|---|
| `boolean` | `true` if this file is a directory, `false` otherwise. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.Document.html#MIME_TYPE_DIR` |   |

### isDocumentUri

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public static boolean isDocumentUri(@NonNull Context context, @Nullable Uri uri)
```

Test if given Uri is backed by a `https://developer.android.com/reference/android/provider/DocumentsProvider.html`.

### isFile

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract boolean isFile()
```

Indicates if this file represents a *file*.

| Returns |
|---|---|
| `boolean` | `true` if this file is a file, `false` otherwise. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.Document.html#COLUMN_MIME_TYPE` |   |

### isVirtual

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract boolean isVirtual()
```

Indicates if this file represents a *virtual* document.

| Returns |
|---|---|
| `boolean` | `true` if this file is a virtual document. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.Document.html#FLAG_VIRTUAL_DOCUMENT` |   |

### lastModified

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract long lastModified()
```

Returns the time when this file was last modified, measured in milliseconds since January 1st, 1970, midnight. Returns 0 if the file does not exist, or if the modified time is unknown.

| Returns |
|---|---|
| `long` | the time when this file was last modified. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.Document.html#COLUMN_LAST_MODIFIED` |   |

### length

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract long length()
```

Returns the length of this file in bytes. Returns 0 if the file does not exist, or if the length is unknown. The result for a directory is not defined.

| Returns |
|---|---|
| `long` | the number of bytes in this file. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.Document.html#COLUMN_SIZE` |   |

### listFiles

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract @NonNull DocumentFile[] listFiles()
```

Returns an array of files contained in the directory represented by this file.

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html DocumentFile[]` | an array of files. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException.html` | when working with a single document created from `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#fromSingleUri(android.content.Context,android.net.Uri)`. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.html#buildChildDocumentsUriUsingTree(android.net.Uri, java.lang.String)` |   |

### renameTo

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/documentfile#1.0.0)

```
public abstract boolean renameTo(@NonNull String displayName)
```

Renames this file to `displayName`.

Note that this method does *not* throw `IOException` on failure. Callers must check the return value.

Some providers may need to create a new document to reflect the rename, potentially with a different MIME type, so `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#getUri()` and `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#getType()` may change to reflect the rename.

When renaming a directory, children previously enumerated through `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#listFiles()` may no longer be valid.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html displayName` | the new display name. |

| Returns |
|---|---|
| `boolean` | true on success. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException.html` | when working with a single document created from `https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#fromSingleUri(android.content.Context,android.net.Uri)`. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/provider/DocumentsContract.html#renameDocument(android.content.ContentResolver, android.net.Uri, java.lang.String)` |   |