DocumentFile

canRead

boolean canRead ()

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

canWrite

boolean canWrite ()

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

createDirectory

DocumentFile createDirectory (String displayName)

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

createFile

DocumentFile createFile (String mimeType, 
                String displayName)

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

delete

boolean delete ()

Deletes this file.

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

exists

boolean exists ()

Returns a boolean indicating whether this file can be found.

findFile

DocumentFile findFile (String displayName)

Search through listFiles() for the first document matching the given display name. Returns null when no matching document is found.

fromFile

DocumentFile fromFile (File file)

Create a DocumentFile representing the filesystem tree rooted at the given File. This doesn't give you any additional access to the underlying files beyond what your app already has.

getUri() will return file:// Uris for files explored through this tree.

fromSingleUri

DocumentFile fromSingleUri (Context context, 
                Uri singleUri)

Create a DocumentFile representing the single document at the given Uri. This is only useful on devices running KITKAT or later, and will return null when called on earlier platform versions.

fromTreeUri

DocumentFile fromTreeUri (Context context, 
                Uri treeUri)

Create a DocumentFile representing the document tree rooted at the given Uri. This is only useful on devices running LOLLIPOP or later, and will return null when called on earlier platform versions.

getName

String getName ()

Return the display name of this document.

getParentFile

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

String getType ()

Return the MIME type of this document.

getUri

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 isDocumentUri(Context, Uri) to test if the returned Uri is backed by a DocumentsProvider.

isDirectory

boolean isDirectory ()

Indicates if this file represents a directory.

isDocumentUri

boolean isDocumentUri (Context context, 
                Uri uri)

Test if given Uri is backed by a DocumentsProvider.

isFile

boolean isFile ()

Indicates if this file represents a file.

isVirtual

boolean isVirtual ()

Indicates if this file represents a virtual document.

lastModified

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.

length

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.

listFiles

DocumentFile[] listFiles ()

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

renameTo

boolean renameTo (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 getUri() and getType() may change to reflect the rename.

When renaming a directory, children previously enumerated through listFiles() may no longer be valid.