Index (engineering.swat:java-watch 0.9.4 API)

A

ActiveWatch - Interface in engineering.swat.watch: Marker interface for an active watch, in the future might get more properties you can inspect.
ALL - engineering.swat.watch.Approximation: Synthetic events of kinds WatchEvent.Kind.CREATED and WatchEvent.Kind.MODIFIED, but not WatchEvent.Kind.DELETED, are issued for all regular files/directories in the scope of the watch.
Approximation - Enum in engineering.swat.watch: Constants to indicate for which regular files/directories in the scope of the watch an approximation of synthetic events (of kinds WatchEvent.Kind.CREATED, WatchEvent.Kind.MODIFIED, and/or WatchEvent.Kind.DELETED) should be issued when an overflow event happens.
areEquivalent(WatchEvent, WatchEvent) - Static method in class engineering.swat.watch.WatchEvent: Tests the equivalence of two events.

build(Path, WatchScope) - Static method in class engineering.swat.watch.Watch: Watch a path for updates, optionally also get events for its children/descendants
buildConstrainedCached(String, int) - Static method in class engineering.swat.watch.DaemonThreadPool: Generate a thread pool that will reuse threads, clear them after a while, but constrain the total amount of threads.

DaemonThreadPool - Class in engineering.swat.watch: Build thread pools that even when not properly shutdown, will still not prevent the termination of the JVM.
DELETED - engineering.swat.watch.WatchEvent.Kind: The path entry was deleted.
DIFF - engineering.swat.watch.Approximation: Synthetic events of kinds WatchEvent.Kind.CREATED, WatchEvent.Kind.MODIFIED, and WatchEvent.Kind.DELETED are issued for regular files/directories in the scope of the watch, when their current versions are different from their previous versions, as determined using last-modified-times.

MODIFIED - engineering.swat.watch.WatchEvent.Kind: The path entry was saved.

NONE - engineering.swat.watch.Approximation: Synthetic events are issued for no regular files/directories in the scope of the watch.

on(WatchEventListener) - Method in class engineering.swat.watch.Watch: Convenience variant of Watch.on(Consumer), which allows you to only respond to certain events
on(Consumer<WatchEvent>) - Method in class engineering.swat.watch.Watch: Callback that gets executed for every event.
onCreated(WatchEvent) - Method in interface engineering.swat.watch.WatchEventListener: executed in case of a create event
onDeleted(WatchEvent) - Method in interface engineering.swat.watch.WatchEventListener: executed in case of a delete event
onModified(WatchEvent) - Method in interface engineering.swat.watch.WatchEventListener: executed in case of a modified event
onOverflow(Approximation) - Method in class engineering.swat.watch.Watch: Optionally configure which regular files/directories in the scope of the watch an approximation of synthetic events (of kinds WatchEvent.Kind.CREATED, WatchEvent.Kind.MODIFIED, and/or WatchEvent.Kind.DELETED) should be issued when an overflow event happens.
onOverflow(WatchEvent) - Method in interface engineering.swat.watch.WatchEventListener: executed in case of a overflow event
OVERFLOW - engineering.swat.watch.WatchEvent.Kind: Rare event where there were so many file events, that the kernel lost a few.

PATH_AND_ALL_DESCENDANTS - engineering.swat.watch.WatchScope: Watch changes to (metadata of) a directory and its content, recursively.
PATH_AND_CHILDREN - engineering.swat.watch.WatchScope: Watch changes to (metadata of) a directory and its content, non-recursively.
PATH_ONLY - engineering.swat.watch.WatchScope: Watch changes to a single file or (metadata of) a single directory.

start() - Method in class engineering.swat.watch.Watch: Start watch the path for events.

valueOf(String) - Static method in enum engineering.swat.watch.Approximation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum engineering.swat.watch.WatchEvent.Kind: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum engineering.swat.watch.WatchScope: Returns the enum constant of this type with the specified name.
values() - Static method in enum engineering.swat.watch.Approximation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum engineering.swat.watch.WatchEvent.Kind: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum engineering.swat.watch.WatchScope: Returns an array containing the constants of this enum type, in the order they are declared.

Watch - Class in engineering.swat.watch: Watch a path for changes.
WatchEvent - Class in engineering.swat.watch: The library publishes these events to all subscribers, they are immutable and safe to share around.
WatchEvent(WatchEvent.Kind, Path) - Constructor for class engineering.swat.watch.WatchEvent: Internal constructor an end user should never call, creates a new watch event for the root of a watch
WatchEvent(WatchEvent.Kind, Path, Path) - Constructor for class engineering.swat.watch.WatchEvent: Internal constructor an end user should never call, creates a new watch event
WatchEvent.Kind - Enum in engineering.swat.watch: What happened with the file or directory
WatchEventListener - Interface in engineering.swat.watch: A visit like interface that allows you to only override the functions you are interested in
WatchScope - Enum in engineering.swat.watch: Configure the depth of the events you want to receive for a given path
withExecutor(Executor) - Method in class engineering.swat.watch.Watch: Optionally configure the executor in which the Watch.on(Consumer) callbacks are scheduled.