cz.gyarab.util.fx

Class FXSync

java.lang.Object

cz.gyarab.util.fx.FXSync

All Implemented Interfaces:

java.lang.Runnable

public abstract class FXSync
extends java.lang.Object
implements java.lang.Runnable

Pomocná synchronizační třída při práci s JavaFX. Některé (většina) úkony v FX lze provádět pouze vhodným vláknem (JavaFX Application Thread, FXAT). Na rozdíl od Swingu JavaFX při použití nesprávného vlákna vyvolá výjimku. Aby bylo možné vykonat kód, který by jinak vykonalo nějaké ne-FXAT vlákno, obvykle se používá konstrukce pomocí Platform.runLater(java.lang.Runnable).

 StringBuilder sb = new StringBuilder("Moje aplikace");
 if (userLogged()) sb.append(": uživatel ").append(getUsreName());
 // stage.setTitle(sb.toString()) nelze zde použít přímo
 Platform.invokeLater(() -> stage.setTitle(sb.toString()));
 

Obvykle nám stačí vědomí, že "někdy potom" se kód spustí, jindy ale potřebujeme pokračovat, až když je kód provedený FXAT vláknem dokončen. Bohužel Platform neposkytuje metodu runLaterAndWait() veřejně (podobná metoda je v SwingUtilities.invokeAndWait(java.lang.Runnable)).

A to je právě prostor pro tuto třídu. Tu lze používat staticky (podobně jako Platform) i objektově (implementováním metody call().

Since:

1.4

Constructor Summary

Constructors

Constructor and Description
FXSync() Vytvoří instanci synchornizačního zámku.

Method Summary

Modifier and Type	Method and Description
void	await() Čeká na uvolnění zámku (voláno volajícím vláknem).
boolean	await(long timeout, java.util.concurrent.TimeUnit unit) Čeká na uvolnění zámku (voláno volajícím vláknem).
protected abstract boolean	call() Kód, který se má provést volaný FXAT vláknem.
void	done() Signalizace dokončení akce (voláno FXAT vláknem).
java.lang.Runnable	finished() Signalizace dokončení akce (voláno FXAT vláknem).
void	run()
static void	runInFx(java.lang.Runnable run) Spustí poskytnutý kód v FXAT vlákně bez ohledu na to, z jakého vlákna je metoda spuštěna.
static <T> T	runInFx(T obj, java.util.function.Consumer<T> run) Spustí poskytnutý kód v FXAT vlákně bez ohledu na to, z jakého vlákna je metoda spuštěna.
static void	runLaterAndWait(java.lang.Runnable run) Spustí poskytnutý kód v FXAT vlákně a vrátí se, až je kód dokončen.

Methods inherited from class java.lang.Object

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

Constructor Detail

FXSync

public FXSync()
       throws java.lang.IllegalStateException

Vytvoří instanci synchornizačního zámku. Tento zámek by se posléze měl předat FXAT vláknu ke spuštění (Platform.runLater(java.lang.Runnable)) a počkat na jeho uvolnění.

Throws:

java.lang.IllegalStateException - při spuštění v FXAT vlákně

Method Detail

runLaterAndWait

public static void runLaterAndWait(java.lang.Runnable run)
                            throws java.lang.IllegalStateException

Spustí poskytnutý kód v FXAT vlákně a vrátí se, až je kód dokončen.

Tuto metodu z principu nelze volat z FXAT vlákna. Pokud je potřeba spustit nějaký kód v FXAT z neznámeho vlákna, může posloužit metoda runInFx(java.lang.Runnable).

Parameters:

run - spouštěný kód

Throws:

java.lang.IllegalStateException - pokud je metoda spuštěna FXAT vláknem, nebo pokud naopak správným vláknem v situaci, že FXAT ještě nebylo inicializováno; bohužel není možné zjistit, zda FXAT vlákno již bylo ukončeno, v takovém případě dojde k uváznutí.

runInFx

public static void runInFx(java.lang.Runnable run)
                    throws java.lang.IllegalStateException

Spustí poskytnutý kód v FXAT vlákně bez ohledu na to, z jakého vlákna je metoda spuštěna. Pokud z FXAT, bude kód spuštěn přímo, pokud mimo, tak nepřímo přes runLaterAndWait(java.lang.Runnable). Tato metoda nevrací žádnou hodnotu, jen čeká na dokončení. Pokud je potřeba předat volanému parametr, může posloužit runInFx(java.lang.Object, java.util.function.Consumer).

Parameters:

run - spouštěný kód

Throws:

java.lang.IllegalStateException - pokud ještě nebylo FXAT inicializováno (např. spuštěním FX aplikace)

runInFx

public static <T> T runInFx(T obj,
                            java.util.function.Consumer<T> run)
                     throws java.lang.IllegalStateException

Spustí poskytnutý kód v FXAT vlákně bez ohledu na to, z jakého vlákna je metoda spuštěna. Pokud z FXAT, bude kód spuštěn přímo, pokud mimo, tak nepřímo přes runLaterAndWait(java.lang.Runnable). Tato metoda vrací hodnotu zadanou jako první parametr, aby na ní bylo možné aplikovat techniku zřetězení metod. Tento parametr rovněž předá volanému kódu.

Type Parameters:

T - typový parametr předaného referenčního objektu (rovněž typ návratové hodnty)

Parameters:

obj - referenční objekt, nejprve bude předán spouštěnému kód, následně vrácen metodou

run - spouštěný kód

Returns:

referenční objekt (kvůli zřetězení metod)

Throws:

java.lang.IllegalStateException - pokud ještě nebylo FXAT inicializováno (např. spuštěním FX aplikace)

run

public final void run()

Specified by:

run in interface java.lang.Runnable

await

public final void await()

Čeká na uvolnění zámku (voláno volajícím vláknem). K tomu dojde ve chvíli, kdy FXAT vlákno dokončí svou práci na tomto objektu. Bohužel, FXAT vlákno svou práci nikdy dokončit nemusí, takže tato metoda zůstane bez dokončení. Proto může být vhodnější použití metody stanovující maximální dobu čekání await(long, java.util.concurrent.TimeUnit).

See Also:

CountDownLatch.await()

await

public final boolean await(long timeout,
                           java.util.concurrent.TimeUnit unit)

Čeká na uvolnění zámku (voláno volajícím vláknem). K tomu dojde ve chvíli, kdy FXAT vlákno dokončí svou práci na tomto objektu. Bohužel, FXAT vlákno svou práci nikdy dokončit nemusí, takže tato metoda bude čekat nejdéle po poskytnutou dobu, pak to vzdá a vrátí false.

Parameters:

timeout - doba, jak dlouho bude volající vlákno čekat na odemknutí

unit - časová jednotka odpovídající hodnotě

Returns:

true, pokud byla práce dokončena, false, pokud ani po uplynutí poskytnuté doby nedošlo k úspěšnému dokončení

done

public final void done()

Signalizace dokončení akce (voláno FXAT vláknem).

See Also:

finished()

finished

public final java.lang.Runnable finished()

Signalizace dokončení akce (voláno FXAT vláknem).

Returns:

spustitelný kód, který, když bude zavolán, signalizuje dokončení (vhodné pro onXXXFinished handlery událostí).

See Also:

done()

call

protected abstract boolean call()

Kód, který se má provést volaný FXAT vláknem.

Returns:

true, pokud vše proběhlo správně a je třeba signalizovat dokončení, pokud false, signalizace se neprovede (možná už se provedla uvnitř kódu, možná se provede později jako reakce na asynchronní událost)