JabRef 6.0-beta.1 · org.jabref.gui.collab.DatabaseChangeMonitor

Modifier and Type	Class and Description
private class	DatabaseChangeMonitor.ExternalLibraryChangeNotification

Field Summary

Modifier and Type	Field and Description
private @Nullable DatabaseChangeMonitor.ExternalLibraryChangeNotification	activeNotification
private boolean	changeDetectionSuspended
private final BibDatabaseContext	database
private final DialogService	dialogService
private final FileUpdateMonitor	fileMonitor
private @Nullable FileSnapshot	knownDiskState State of the monitored file as of the last scan or the last point where the in-memory library was known to match the disk (library load, successful save, all external changes merged).
private final LibraryTab	libraryTab
private final List<DatabaseChangeListener>	listeners
private static final Logger	LOGGER
private final Optional<Path>	monitoredPath
private final GuiPreferences	preferences
private final StateManager	stateManager
private final TaskExecutor	taskExecutor
private final UndoManager	undoManager

Constructor Summary

Access	Constructor and Description
public	DatabaseChangeMonitor(BibDatabaseContext database, FileUpdateMonitor fileMonitor, TaskExecutor taskExecutor, DialogService dialogService, GuiPreferences preferences, UndoManager undoManager, StateManager stateManager, LibraryTab libraryTab)

Method Summary

Modifier and Type	Method and Description
public void	addListener(DatabaseChangeListener listener)
pack-priv void	applyResolvedChanges(List<DatabaseChange> the externally resolved changes to apply to the in-memory database resolvedChanges, boolean `true` if the accepted result now matches the file on disk, so the library can be marked clean; `false` if the resolved result differs from disk and still needs saving resolvedChangesMatchDisk) Applies the accepted external changes and updates the library's dirty state.
private void	clearActiveNotification(DatabaseChangeMonitor.ExternalLibraryChangeNotification notification)
public void	fileUpdated()
public void	markConsistentWithDisk(@Nullable FileSnapshot the matching on-disk state, ideally as reported by the writer that committed it (captured right after the commit, this leaves no window in which a concurrent write could be mistaken for the consistent state); `null` to read the current state from the file instead, which is subject to such a window — its worst case is a delayed notification, never a lost update, since lost-update protection lives in `org.jabref.logic.exporter.AtomicFileOutputStream` diskState) Records the given file state as consistent with the in-memory library.
pack-priv void	notifyExternalChanges(List<DatabaseChange> changes)
public void	resumeChangeDetection()
private void	scanForChanges() Looks for notable changes of the file on disk compared to the in-memory library and notifies listeners in case there are such changes.
private void	scanIfFileChanged() A full scan parses the whole library file, so it is skipped when size and modification time show that the file has not actually changed since the last known-consistent state — e.g. for events caused by JabRef's own save.
public void	suspendChangeDetection() Defers handling of file events while keeping the watcher registered, so that events arriving during JabRef's own save are neither acted upon (the file may be half-written) nor lost.
public void	unregister()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

activeNotification	back to summary
private @Nullable DatabaseChangeMonitor.ExternalLibraryChangeNotification activeNotification

changeDetectionSuspended	back to summary
private boolean changeDetectionSuspended

database	back to summary
private final BibDatabaseContext database

dialogService	back to summary
private final DialogService dialogService

fileMonitor	back to summary
private final FileUpdateMonitor fileMonitor

knownDiskState	back to summary
private @Nullable FileSnapshot knownDiskState State of the monitored file as of the last scan or the last point where the in-memory library was known to match the disk (library load, successful save, all external changes merged). Guarded by `synchronized (database)`; `null` when unknown, in which case the next event triggers a full scan.

libraryTab	back to summary
private final LibraryTab libraryTab

listeners	back to summary
private final List<DatabaseChangeListener> listeners

LOGGER	back to summary
private static final Logger LOGGER

monitoredPath	back to summary
private final Optional<Path> monitoredPath

preferences	back to summary
private final GuiPreferences preferences

stateManager	back to summary
private final StateManager stateManager

taskExecutor	back to summary
private final TaskExecutor taskExecutor

undoManager	back to summary
private final UndoManager undoManager

Constructor Detail

DatabaseChangeMonitor	back to summary
public DatabaseChangeMonitor(BibDatabaseContext database, FileUpdateMonitor fileMonitor, TaskExecutor taskExecutor, DialogService dialogService, GuiPreferences preferences, UndoManager undoManager, StateManager stateManager, LibraryTab libraryTab)

Method Detail

addListener	back to summary
public void addListener(DatabaseChangeListener listener)

applyResolvedChanges back to summary

applyResolvedChanges	back to summary
pack-priv void applyResolvedChanges(List<DatabaseChange> resolvedChanges, boolean resolvedChangesMatchDisk) Applies the accepted external changes and updates the library's dirty state. Parameters resolvedChanges:List<DatabaseChange> the externally resolved changes to apply to the in-memory database resolvedChangesMatchDisk:boolean `true` if the accepted result now matches the file on disk, so the library can be marked clean; `false` if the resolved result differs from disk and still needs saving

pack-priv void applyResolvedChanges(List<DatabaseChange> resolvedChanges, boolean resolvedChangesMatchDisk)

Applies the accepted external changes and updates the library's dirty state.

Parameters

resolvedChanges:List<DatabaseChange>: the externally resolved changes to apply to the in-memory database
resolvedChangesMatchDisk:boolean: true if the accepted result now matches the file on disk, so the library can be marked clean; false if the resolved result differs from disk and still needs saving

clearActiveNotification	back to summary
private void clearActiveNotification(DatabaseChangeMonitor.ExternalLibraryChangeNotification notification)

fileUpdated	back to summary
public void fileUpdated() Annotations @Override

markConsistentWithDisk back to summary

markConsistentWithDisk	back to summary
public void markConsistentWithDisk(@Nullable FileSnapshot diskState) Records the given file state as consistent with the in-memory library. To be called whenever the two are known to match (successful save, all external changes merged), so that watcher events reflecting that very state do not trigger a scan. Parameters diskState:@Nullable FileSnapshot the matching on-disk state, ideally as reported by the writer that committed it (captured right after the commit, this leaves no window in which a concurrent write could be mistaken for the consistent state); `null` to read the current state from the file instead, which is subject to such a window — its worst case is a delayed notification, never a lost update, since lost-update protection lives in `org.jabref.logic.exporter.AtomicFileOutputStream`

public void markConsistentWithDisk(@Nullable FileSnapshot diskState)

Records the given file state as consistent with the in-memory library. To be called whenever the two are known to match (successful save, all external changes merged), so that watcher events reflecting that very state do not trigger a scan.

Parameters

diskState:@Nullable FileSnapshot: the matching on-disk state, ideally as reported by the writer that committed it (captured right after the commit, this leaves no window in which a concurrent write could be mistaken for the consistent state); null to read the current state from the file instead, which is subject to such a window — its worst case is a delayed notification, never a lost update, since lost-update protection lives in org.jabref.logic.exporter.AtomicFileOutputStream

notifyExternalChanges	back to summary
pack-priv void notifyExternalChanges(List<DatabaseChange> changes)

resumeChangeDetection	back to summary
public void resumeChangeDetection()

scanForChanges	back to summary
private void scanForChanges() Looks for notable changes of the file on disk compared to the in-memory library and notifies listeners in case there are such changes.

scanIfFileChanged	back to summary
private void scanIfFileChanged() A full scan parses the whole library file, so it is skipped when size and modification time show that the file has not actually changed since the last known-consistent state — e.g. for events caused by JabRef's own save.

suspendChangeDetection	back to summary
public void suspendChangeDetection() Defers handling of file events while keeping the watcher registered, so that events arriving during JabRef's own save are neither acted upon (the file may be half-written) nor lost.

unregister	back to summary
public void unregister()

public Class DatabaseChangeMonitor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DatabaseChangeMonitor.ExternalLibraryChangeNotification

Constructor Summary

Constructor Detail