Added in API level 1

Summary: Constants | Ctors | Methods | Protected Methods | Inherited Methods

FileObserver

Kotlin |Java

public abstract class FileObserver
extends Object

java.lang.Object
↳	android.os.FileObserver

Monitors files (using inotify) to fire an event after files are accessed or changed by any process on the device (including this one). FileObserver is an abstract class; subclasses must implement the event handler onEvent(int, java.lang.String).

Each FileObserver instance can monitor multiple files or directories. If a directory is monitored, events will be triggered for all files and subdirectories inside the monitored directory.

An event mask is used to specify which changes or actions to report. Event type constants are used to describe the possible changes in the event mask as well as what actually happened in event callbacks.

Warning: If a FileObserver is garbage collected, it will stop sending events. To ensure you keep receiving events, you must keep a reference to the FileObserver instance from some other live object.

Summary

Constants
`int`	`ACCESS` Event type: Data was read from a file
`int`	`ALL_EVENTS` Event mask: All valid event types, combined Value is either `0` or a combination of `ACCESS`, `MODIFY`, `ATTRIB`, `CLOSE_WRITE`, `CLOSE_NOWRITE`, `OPEN`, `MOVED_FROM`, `MOVED_TO`, `CREATE`, `DELETE`, `DELETE_SELF`, and `MOVE_SELF`
`int`	`ATTRIB` Event type: Metadata (permissions, owner, timestamp) was changed explicitly
`int`	`CLOSE_NOWRITE` Event type: Someone had a file or directory open read-only, and closed it
`int`	`CLOSE_WRITE` Event type: Someone had a file or directory open for writing, and closed it
`int`	`CREATE` Event type: A new file or subdirectory was created under the monitored directory
`int`	`DELETE` Event type: A file was deleted from the monitored directory
`int`	`DELETE_SELF` Event type: The monitored file or directory was deleted; monitoring effectively stops
`int`	`MODIFY` Event type: Data was written to a file
`int`	`MOVED_FROM` Event type: A file or subdirectory was moved from the monitored directory
`int`	`MOVED_TO` Event type: A file or subdirectory was moved to the monitored directory
`int`	`MOVE_SELF` Event type: The monitored file or directory was moved; monitoring continues
`int`	`OPEN` Event type: A file or directory was opened

Public constructors
`FileObserver(String path)` This constructor is deprecated. use `FileObserver(java.io.File)` instead.
`FileObserver(File file)` Equivalent to FileObserver(file, FileObserver.ALL_EVENTS).
`FileObserver(List<File> files)` Equivalent to FileObserver(paths, FileObserver.ALL_EVENTS).
`FileObserver(String path, int mask)` This constructor is deprecated. use `FileObserver(java.io.File, int)` instead.
`FileObserver(File file, int mask)` Create a new file observer for a certain file or directory.
`FileObserver(List<File> files, int mask)` Version of `FileObserver(java.io.File, int)` that allows callers to monitor multiple files or directories.

Public methods
`abstract void`	`onEvent(int event, String path)` The event handler, which must be implemented by subclasses.
`void`	`startWatching()` Start watching for events.
`void`	`stopWatching()` Stop watching for events.

Protected methods
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited methods

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.

Constants

ACCESS

Added in API level 1

public static final int ACCESS

Event type: Data was read from a file

Constant Value: 1 (0x00000001)

ALL_EVENTS

Added in API level 1

public static final int ALL_EVENTS

Event mask: All valid event types, combined
Value is either 0 or a combination of ACCESS, MODIFY, ATTRIB, CLOSE_WRITE, CLOSE_NOWRITE, OPEN, MOVED_FROM, MOVED_TO, CREATE, DELETE, DELETE_SELF, and MOVE_SELF

Constant Value: 4095 (0x00000fff)

ATTRIB

Added in API level 1

public static final int ATTRIB

Event type: Metadata (permissions, owner, timestamp) was changed explicitly

Constant Value: 4 (0x00000004)

CLOSE_NOWRITE

Added in API level 1

public static final int CLOSE_NOWRITE

Event type: Someone had a file or directory open read-only, and closed it

Constant Value: 16 (0x00000010)

CLOSE_WRITE

Added in API level 1

public static final int CLOSE_WRITE

Event type: Someone had a file or directory open for writing, and closed it

Constant Value: 8 (0x00000008)

CREATE

Added in API level 1

public static final int CREATE

Event type: A new file or subdirectory was created under the monitored directory

Constant Value: 256 (0x00000100)

DELETE

Added in API level 1

public static final int DELETE

Event type: A file was deleted from the monitored directory

Constant Value: 512 (0x00000200)

DELETE_SELF

Added in API level 1

public static final int DELETE_SELF

Event type: The monitored file or directory was deleted; monitoring effectively stops

Constant Value: 1024 (0x00000400)

MODIFY

Added in API level 1

public static final int MODIFY

Event type: Data was written to a file

Constant Value: 2 (0x00000002)

MOVED_FROM

Added in API level 1

public static final int MOVED_FROM

Event type: A file or subdirectory was moved from the monitored directory

Constant Value: 64 (0x00000040)

MOVED_TO

Added in API level 1

public static final int MOVED_TO

Event type: A file or subdirectory was moved to the monitored directory

Constant Value: 128 (0x00000080)

MOVE_SELF

Added in API level 1

public static final int MOVE_SELF

Event type: The monitored file or directory was moved; monitoring continues

Constant Value: 2048 (0x00000800)

OPEN

Added in API level 1

public static final int OPEN

Event type: A file or directory was opened

Constant Value: 32 (0x00000020)

Public constructors

FileObserver

Added in API level 1

public FileObserver (String path)

This constructor is deprecated.
use FileObserver(java.io.File) instead.

Equivalent to FileObserver(path, FileObserver.ALL_EVENTS).

Parameters
`path`	`String`

FileObserver

Added in API level 29

public FileObserver (File file)

Equivalent to FileObserver(file, FileObserver.ALL_EVENTS).

Parameters
`file`	`File`: This value cannot be `null`.

FileObserver

Added in API level 29

public FileObserver (List<File> files)

Equivalent to FileObserver(paths, FileObserver.ALL_EVENTS).

Parameters
`files`	`List`: The files or directories to monitor This value cannot be `null`.

FileObserver

Added in API level 1

public FileObserver (String path, 
                int mask)

This constructor is deprecated.
use FileObserver(java.io.File, int) instead.

Create a new file observer for a certain file or directory. Monitoring does not start on creation! You must call startWatching() before you will receive events.

Parameters
`path`	`String`: The file or directory to monitor
`mask`	`int`: The event or events (added together) to watch for Value is either `0` or a combination of `ACCESS`, `MODIFY`, `ATTRIB`, `CLOSE_WRITE`, `CLOSE_NOWRITE`, `OPEN`, `MOVED_FROM`, `MOVED_TO`, `CREATE`, `DELETE`, `DELETE_SELF`, and `MOVE_SELF`

FileObserver

Added in API level 29

public FileObserver (File file, 
                int mask)

Create a new file observer for a certain file or directory. Monitoring does not start on creation! You must call startWatching() before you will receive events.

Parameters
`file`	`File`: The file or directory to monitor This value cannot be `null`.
`mask`	`int`: The event or events (added together) to watch for Value is either `0` or a combination of `ACCESS`, `MODIFY`, `ATTRIB`, `CLOSE_WRITE`, `CLOSE_NOWRITE`, `OPEN`, `MOVED_FROM`, `MOVED_TO`, `CREATE`, `DELETE`, `DELETE_SELF`, and `MOVE_SELF`

FileObserver

Added in API level 29

public FileObserver (List<File> files, 
                int mask)

Version of FileObserver(java.io.File, int) that allows callers to monitor multiple files or directories.

Parameters
`files`	`List`: The files or directories to monitor This value cannot be `null`.
`mask`	`int`: The event or events (added together) to watch for Value is either `0` or a combination of `ACCESS`, `MODIFY`, `ATTRIB`, `CLOSE_WRITE`, `CLOSE_NOWRITE`, `OPEN`, `MOVED_FROM`, `MOVED_TO`, `CREATE`, `DELETE`, `DELETE_SELF`, and `MOVE_SELF`

Public methods

onEvent

Added in API level 1

public abstract void onEvent (int event, 
                String path)

The event handler, which must be implemented by subclasses.

This method is invoked on a special FileObserver thread. It runs independently of any threads, so take care to use appropriate synchronization! Consider using Handler#post(Runnable) to shift event handling work to the main thread to avoid concurrency problems.

Event handlers must not throw exceptions.

Parameters
`event`	`int`: The type of event which happened
`path`	`String`: The path, relative to the main monitored file or directory, of the file or directory which triggered the event. This value can be `null` for certain events, such as `MOVE_SELF`.

startWatching

Added in API level 1

public void startWatching ()

Start watching for events. The monitored file or directory must exist at this time, or else no events will be reported (even if it appears later). If monitoring is already started, this call has no effect.

stopWatching

Added in API level 1

public void stopWatching ()

Stop watching for events. Some events may be in process, so events may continue to be reported even after this method completes. If monitoring is already stopped, this call has no effect.

Protected methods

finalize

Added in API level 1

protected void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.