AppDataFileSource

Kotlin |Java

public final class AppDataFileSource
extends OperationSource

java.lang.Object
↳	android.os.storage.operations.sources.OperationSource
	↳	android.os.storage.operations.sources.AppDataFileSource

A source representing a file within the calling application's private app data directory.

This source is restricted to files located inside the application's internal data directory (as returned by Context.getDataDir()).

Operation Rejection

To ensure system security and integrity, operations using an AppDataFileSource will be rejected with FileOperationResult.ERROR_UNSUPPORTED_SOURCE or FileOperationResult.ERROR_INVALID_REQUEST if:

The provided path is not absolute.
The path contains path traversal elements (e.g., "..") or redundant segments.
The path contains unsafe control characters (e.g., null, newline).
The file is outside the application's internal data directory (CE or DE storage). Locations such as external storage or system directories are strictly prohibited.

Example Usage:

// Obtain the application's data directory using Context
 Context context = getApplicationContext();
 File myDataFile = new File(context.getDataDir(), "subfolder/my_data.txt");

 // Construct the AppDataFileSource with the File object
 AppDataFileSource source = new AppDataFileSource(myDataFile);

 // The source can now be used in storage operations

See also:

Context.getDataDir()

Summary

Public constructors
`AppDataFileSource(File file)` Creates a new source for the specified file.

Public methods
`File`	`getFile()` Returns the file associated with this source.
`String`	`toString()` Returns a string representation of this source for debugging.

Inherited methods

From class


        
          android.os.storage.operations.sources.OperationSource


        abstract
        
        
        
        
        String


      toString()

Returns a human-readable representation of this source.

From class


        
          java.lang.Object

`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

AppDataFileSource

Added in API level 37

public AppDataFileSource (File file)

Creates a new source for the specified file.

Parameters
`file`	`File`: The file to be used as a source. Must be within the application's data directory. This value cannot be `null`.

Public methods

getFile

Added in API level 37

public File getFile ()

Returns the file associated with this source.

Returns
`File`	This value cannot be `null`.

toString

Added in API level 37

public String toString ()

Returns a string representation of this source for debugging.

Returns
`String`	A string containing the source type and path. This value cannot be `null`.