Package ch.powerunit.extensions.async.lang

Class WaitFile

java.lang.Object

ch.powerunit.extensions.async.lang.WaitFile

public final class WaitFile
extends Object

This class provides methods to wait for fileSystem events.

The goal is to wait for filesystem event, by using the WatchService functionality.

Since:

1.1.0

See Also:

WatchService

Method Summary

Modifier and Type	Method	Description
static WaitResultBuilder1<Collection<WatchEvent<Path>>>	eventIn(Path directory, WatchEvent.Kind<Path>... events)	Wait for a folder to have some event.
static WaitResultBuilder1<Collection<Path>>	newFileIn(Path directory)	Wait for a folder to contains new entry.
static WaitResultBuilder1<Path>	newFileNamedIn(Path directory, String name)	Wait for a folder to contains new entry based on his name.
static WaitResultBuilder1<Collection<Path>>	removeFileFrom(Path directory)	Wait for a folder to have entry removed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

eventIn

@SafeVarargs
public static WaitResultBuilder1<Collection<WatchEvent<Path>>> eventIn(Path directory,
                                                                       WatchEvent.Kind<Path>... events)

Wait for a folder to have some event.

The wait starts at the first try to get the result.

For example :

 CompletableFuture<Optional<Collection<WatchEvent<Path>>>> wait = WaitFile
                .eventIn(test, StandardWatchEventKinds.ENTRY_CREATE)
                .expecting(l -> l.stream().map(WatchEvent::context).map(Path::getFileName).map(Path::toString)
                                .anyMatch(n -> n.equals("test")))
                .repeat(3).every(Duration.ofMillis(250)).usingDefaultExecutor().asyncExec();
 

Defines a 3 tries with a wait time of 250ms, for a creation event, containing at least one event with last part of a path named test.

Parameters:

directory - the directory to be verified.

events - the events to wait for.

Returns:

WaitResultBuilder1 the next step of the builder.

newFileIn

public static WaitResultBuilder1<Collection<Path>> newFileIn(Path directory)

Wait for a folder to contains new entry.

The wait starts at the first try to get the result.

For example :

 CompletableFuture<Optional<Collection<Path>>> wait = WaitFile.newFileIn(test)
                .expecting(l -> l.stream().map(Path::getFileName).map(Path::toString).anyMatch(n -> n.equals("test")))
                .repeat(3).every(Duration.ofMillis(250)).usingDefaultExecutor().asyncExec();
 

Defines a 3 tries with a wait time of 250ms, for a list of new file, containing at least one file with last part of a path named test.

Parameters:

directory - the directory to be verified.

Returns:

WaitResultBuilder1 the next step of the builder.

newFileNamedIn

public static WaitResultBuilder1<Path> newFileNamedIn(Path directory,
                                                      String name)

Wait for a folder to contains new entry based on his name.

The wait starts at the first try to get the result.

For example :

 CompletableFuture<Optional<Path>> wait = WaitFile.newFileNamedIn(test, "test").expectingNotNull().repeat(3)
                .every(Duration.ofMillis(250)).usingDefaultExecutor().asyncExec();
 

Defines a 3 tries with a wait time of 25ms, for a file named "test".

Parameters:

directory - the directory to be verified.

name - the expected name

Returns:

WaitResultBuilder1 the next step of the builder.

removeFileFrom

public static WaitResultBuilder1<Collection<Path>> removeFileFrom(Path directory)

Wait for a folder to have entry removed.

The wait starts at the first try to get the result.

Parameters:

directory - the directory to be verified.

Returns:

WaitResultBuilder1 the next step of the builder.