Verified Owner
Top Fields Constructors Methods
org.jabref.gui.walkthrough.declarative.sideeffect

public Class SideEffectExecutor

extends Object
Class Inheritance
Imports
java.util.ArrayList, .List, java.util.concurrent.CompletableFuture, .ExecutionException, .TimeUnit, .TimeoutException, javafx.animation.PauseTransition, javafx.beans.InvalidationListener, .Observable, javafx.util.Duration, org.jabref.gui.DialogService, org.jabref.gui.walkthrough.Walkthrough, org.jabref.logic.l10n.Localization, com.airhacks.afterburner.injection.Injector, org.jspecify.annotations.NonNull, .Nullable, org.slf4j.Logger, .LoggerFactory

Field Summary

Modifier and TypeField and Description
private final List<Observable>
currentDependencies

private @Nullable InvalidationListener
dependencyListener

private static final Logger
LOGGER

private @Nullable PauseTransition
timeoutTransition

Constructor Summary

AccessConstructor and Description
public
SideEffectExecutor()

Method Summary

Modifier and TypeMethod and Description
private void
cancelTimeout()

private void
cleanUp()

private void
cleanUpDependencies()

private boolean
execute(@NonNull WalkthroughSideEffect sideEffect, @NonNull Walkthrough walkthrough, boolean forward)

public boolean

Returns:

true if the side effect was executed successfully, false otherwise
executeBackward(@NonNull WalkthroughSideEffect
the side effect to execute
sideEffect, @NonNull Walkthrough
the walkthrough context
walkthrough)

Executes a side effect's backward action.

public boolean

Returns:

true if the side effect was executed successfully, false otherwise
executeForward(@NonNull WalkthroughSideEffect
the side effect to execute
sideEffect, @NonNull Walkthrough
the walkthrough context
walkthrough)

Executes a side effect's forward action, waiting for the expected condition if necessary.

private void
notifyUser(@NonNull String title, @NonNull String message)

private void
setupDependencyMonitoring(@NonNull List<Observable> dependencies, @NonNull Runnable onDependencyChange)

private void
startTimeout(long timeoutMs, @NonNull Runnable onTimeout)

private boolean
waitForCondition(@NonNull WalkthroughSideEffect sideEffect)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

currentDependenciesback to summary
private final List<Observable> currentDependencies
dependencyListenerback to summary
private @Nullable InvalidationListener dependencyListener
LOGGERback to summary
private static final Logger LOGGER
timeoutTransitionback to summary
private @Nullable PauseTransition timeoutTransition

Constructor Detail

SideEffectExecutorback to summary
public SideEffectExecutor()

Method Detail

cancelTimeoutback to summary
private void cancelTimeout()
cleanUpback to summary
private void cleanUp()
cleanUpDependenciesback to summary
private void cleanUpDependencies()
executeback to summary
private boolean execute(@NonNull WalkthroughSideEffect sideEffect, @NonNull Walkthrough walkthrough, boolean forward)
executeBackwardback to summary
public boolean executeBackward(@NonNull WalkthroughSideEffect sideEffect, @NonNull Walkthrough walkthrough)

Executes a side effect's backward action.

Parameters
sideEffect:@NonNull WalkthroughSideEffect

the side effect to execute

walkthrough:@NonNull Walkthrough

the walkthrough context

Returns:boolean

true if the side effect was executed successfully, false otherwise

executeForwardback to summary
public boolean executeForward(@NonNull WalkthroughSideEffect sideEffect, @NonNull Walkthrough walkthrough)

Executes a side effect's forward action, waiting for the expected condition if necessary.

Parameters
sideEffect:@NonNull WalkthroughSideEffect

the side effect to execute

walkthrough:@NonNull Walkthrough

the walkthrough context

Returns:boolean

true if the side effect was executed successfully, false otherwise

notifyUserback to summary
private void notifyUser(@NonNull String title, @NonNull String message)
setupDependencyMonitoringback to summary
private void setupDependencyMonitoring(@NonNull List<Observable> dependencies, @NonNull Runnable onDependencyChange)
startTimeoutback to summary
private void startTimeout(long timeoutMs, @NonNull Runnable onTimeout)
waitForConditionback to summary
private boolean waitForCondition(@NonNull WalkthroughSideEffect sideEffect)