Modifier and Type	Class and Description
public static interface	BackupManager.RestoreResult

Modifier and Type	Field and Description
private final Queue<Path>	backupFilesQueue
private final BibDatabaseContext	bibDatabaseContext
private final CoarseChangeFilter	coarseChangeFilter
private static final int	DELAY_BETWEEN_BACKUP_ATTEMPTS_IN_SECONDS
private final BibEntryTypesManager	entryTypesManager
private final ScheduledThreadPoolExecutor	executor
private final LibraryTab	libraryTab
private static final Logger	LOGGER
private static final int	MAXIMUM_BACKUP_FILE_COUNT
private boolean	needsBackup
private final CliPreferences	preferences
private static final Set<BackupManager>	RUNNING_INSTANCES

Access	Constructor and Description
pack-priv	BackupManager(LibraryTab libraryTab, BibDatabaseContext bibDatabaseContext, CoarseChangeFilter coarseChangeFilter, BibEntryTypesManager entryTypesManager, CliPreferences preferences)

Method Summary

Modifier and Type	Method and Description
public static boolean	Returns: `true` if backup file exists AND differs from originalPath. `false` is the "default" return value in the good case. In case a discarded file exists, `false` is returned, too. In the case of an exception `true` is returned to ensure that the user checks the output. backupFileDiffers(Path Path to the file a backup should be checked for. Example: jabref.bib. originalPath, Path backupDir) Checks whether a backup file exists for the given database file.
pack-priv Optional<Path>	determineBackupPathForNewBackup(Path backupDir)
private static Path	determineDiscardedFile(Path file, Path backupDir)
public static void	discardBackup(BibDatabaseContext Associated `BibDatabaseContext` bibDatabaseContext, Path backupDir) Marks the backup as discarded at the library which is associated with the given `BibDatabaseContext`.
public void	discardBackup(Path backupDir) Marks the backups as discarded.
private void	fillQueue(Path backupDir)
pack-priv static Path	getBackupPathForNewBackup(Path originalPath, Path backupDir) Determines the most recent backup file name
pack-priv static Optional<Path>	getLatestBackupPath(Path originalPath, Path backupDir) Determines the most recent existing backup file name
public synchronized void	listen(BibDatabaseContextChangedEvent event)
pack-priv void	performBackup(Path the full path to the file where the library should be backed up to backupPath) This method is called as soon as the scheduler says: "Do the backup" SIDE EFFECT: Deletes oldest backup file
public static BackupManager.RestoreResult	restoreBackup(Path Path to the file which should be equalized to the backup file. originalPath, Path backupDir) Restores the backup file by copying and overwriting the original one.
public static void	shutdown(BibDatabaseContext Associated `BibDatabaseContext` bibDatabaseContext, Path The path to the backup directory backupDir, boolean True, if a backup should be created createBackup) Shuts down the BackupManager which is associated with the given `BibDatabaseContext`.
private void	shutdown(Path The backup directory backupDir, boolean If the backup manager should still perform a backup createBackup) Unregisters the BackupManager from the eventBus of `BibDatabaseContext`.
public static BackupManager	start(LibraryTab libraryTab, BibDatabaseContext Associated `BibDatabaseContext` bibDatabaseContext, CoarseChangeFilter coarseChangeFilter, BibEntryTypesManager entryTypesManager, CliPreferences preferences) Starts the BackupManager which is associated with the given `BibDatabaseContext`.
private void	startBackupTask(Path backupDir)

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

backupFilesQueue	back to summary
private final Queue<Path> backupFilesQueue

bibDatabaseContext	back to summary
private final BibDatabaseContext bibDatabaseContext

coarseChangeFilter	back to summary
private final CoarseChangeFilter coarseChangeFilter

DELAY_BETWEEN_BACKUP_ATTEMPTS_IN_SECONDS	back to summary
private static final int DELAY_BETWEEN_BACKUP_ATTEMPTS_IN_SECONDS

entryTypesManager	back to summary
private final BibEntryTypesManager entryTypesManager

executor	back to summary
private final ScheduledThreadPoolExecutor executor

libraryTab	back to summary
private final LibraryTab libraryTab

LOGGER	back to summary
private static final Logger LOGGER

MAXIMUM_BACKUP_FILE_COUNT	back to summary
private static final int MAXIMUM_BACKUP_FILE_COUNT

needsBackup	back to summary
private boolean needsBackup

preferences	back to summary
private final CliPreferences preferences

RUNNING_INSTANCES	back to summary
private static final Set<BackupManager> RUNNING_INSTANCES

BackupManager	back to summary
pack-priv BackupManager(LibraryTab libraryTab, BibDatabaseContext bibDatabaseContext, CoarseChangeFilter coarseChangeFilter, BibEntryTypesManager entryTypesManager, CliPreferences preferences)

Method Detail

backupFileDiffers back to summary

backupFileDiffers	back to summary
public static boolean backupFileDiffers(Path originalPath, Path backupDir) Checks whether a backup file exists for the given database file. If it exists, it is checked whether it is newer and different from the original. In case a discarded file is present, the method also returns `false`, See also `discardBackup(Path)`. Parameters originalPath:Path Path to the file a backup should be checked for. Example: jabref.bib. Returns:boolean `true` if backup file exists AND differs from originalPath. `false` is the "default" return value in the good case. In case a discarded file exists, `false` is returned, too. In the case of an exception `true` is returned to ensure that the user checks the output.

public static boolean backupFileDiffers(Path originalPath, Path backupDir)

Checks whether a backup file exists for the given database file. If it exists, it is checked whether it is newer and different from the original.

In case a discarded file is present, the method also returns false, See also discardBackup(Path).

Parameters

originalPath:Path: Path to the file a backup should be checked for. Example: jabref.bib.

Returns:boolean

true if backup file exists AND differs from originalPath. false is the "default" return value in the good case. In case a discarded file exists, false is returned, too. In the case of an exception true is returned to ensure that the user checks the output.

determineBackupPathForNewBackup	back to summary
pack-priv Optional<Path> determineBackupPathForNewBackup(Path backupDir)

determineDiscardedFile	back to summary
private static Path determineDiscardedFile(Path file, Path backupDir)

discardBackup back to summary

discardBackup	back to summary
public static void discardBackup(BibDatabaseContext bibDatabaseContext, Path backupDir) Marks the backup as discarded at the library which is associated with the given `BibDatabaseContext`. Parameters bibDatabaseContext:BibDatabaseContext Associated `BibDatabaseContext`

public static void discardBackup(BibDatabaseContext bibDatabaseContext, Path backupDir)

Marks the backup as discarded at the library which is associated with the given BibDatabaseContext.

Parameters

bibDatabaseContext:BibDatabaseContext: Associated BibDatabaseContext

discardBackup	back to summary
public void discardBackup(Path backupDir) Marks the backups as discarded. We do not delete any files, because the user might want to recover old backup files. Therefore, we mark discarded backups by a --discarded file.

discardBackup

back to summary

public void discardBackup(Path backupDir)

Marks the backups as discarded.

We do not delete any files, because the user might want to recover old backup files. Therefore, we mark discarded backups by a --discarded file.

fillQueue	back to summary
private void fillQueue(Path backupDir)

getBackupPathForNewBackup	back to summary
pack-priv static Path getBackupPathForNewBackup(Path originalPath, Path backupDir) Determines the most recent backup file name

getLatestBackupPath	back to summary
pack-priv static Optional<Path> getLatestBackupPath(Path originalPath, Path backupDir) Determines the most recent existing backup file name

listen	back to summary
public synchronized void listen(BibDatabaseContextChangedEvent event) Annotations @Subscribe

performBackup	back to summary
pack-priv void performBackup(Path backupPath) This method is called as soon as the scheduler says: "Do the backup" SIDE EFFECT: Deletes oldest backup file Parameters backupPath:Path the full path to the file where the library should be backed up to

performBackup

back to summary

pack-priv void performBackup(Path backupPath)

This method is called as soon as the scheduler says: "Do the backup"

SIDE EFFECT: Deletes oldest backup file

Parameters

backupPath:Path: the full path to the file where the library should be backed up to

restoreBackup back to summary

restoreBackup	back to summary
public static BackupManager.RestoreResult restoreBackup(Path originalPath, Path backupDir) Restores the backup file by copying and overwriting the original one. `impl->req~jabgui.autosaveandbackup.complete-backup~1` Parameters originalPath:Path Path to the file which should be equalized to the backup file.

public static BackupManager.RestoreResult restoreBackup(Path originalPath, Path backupDir)

Restores the backup file by copying and overwriting the original one. impl->req~jabgui.autosaveandbackup.complete-backup~1

Parameters

originalPath:Path: Path to the file which should be equalized to the backup file.

shutdown back to summary

shutdown	back to summary
public static void shutdown(BibDatabaseContext bibDatabaseContext, Path backupDir, boolean createBackup) Shuts down the BackupManager which is associated with the given `BibDatabaseContext`. Parameters bibDatabaseContext:BibDatabaseContext Associated `BibDatabaseContext` backupDir:Path The path to the backup directory createBackup:boolean True, if a backup should be created

public static void shutdown(BibDatabaseContext bibDatabaseContext, Path backupDir, boolean createBackup)

Shuts down the BackupManager which is associated with the given BibDatabaseContext.

Parameters

bibDatabaseContext:BibDatabaseContext: Associated BibDatabaseContext
backupDir:Path: The path to the backup directory
createBackup:boolean: True, if a backup should be created

shutdown back to summary

shutdown	back to summary
private void shutdown(Path backupDir, boolean createBackup) Unregisters the BackupManager from the eventBus of `BibDatabaseContext`. This method should only be used when closing a database/JabRef in a normal way. Parameters backupDir:Path The backup directory createBackup:boolean If the backup manager should still perform a backup

private void shutdown(Path backupDir, boolean createBackup)

Unregisters the BackupManager from the eventBus of BibDatabaseContext. This method should only be used when closing a database/JabRef in a normal way.

Parameters

backupDir:Path: The backup directory
createBackup:boolean: If the backup manager should still perform a backup

start back to summary

start	back to summary
public static BackupManager start(LibraryTab libraryTab, BibDatabaseContext bibDatabaseContext, CoarseChangeFilter coarseChangeFilter, BibEntryTypesManager entryTypesManager, CliPreferences preferences) Starts the BackupManager which is associated with the given `BibDatabaseContext`. As long as no database file is present in `BibDatabaseContext`, the `BackupManager` will do nothing. This method is not thread-safe. The caller has to ensure that this method is not called in parallel. Parameters bibDatabaseContext:BibDatabaseContext Associated `BibDatabaseContext`

public static BackupManager start(LibraryTab libraryTab, BibDatabaseContext bibDatabaseContext, CoarseChangeFilter coarseChangeFilter, BibEntryTypesManager entryTypesManager, CliPreferences preferences)

Starts the BackupManager which is associated with the given BibDatabaseContext. As long as no database file is present in BibDatabaseContext, the BackupManager will do nothing.

This method is not thread-safe. The caller has to ensure that this method is not called in parallel.

Parameters

bibDatabaseContext:BibDatabaseContext: Associated BibDatabaseContext

startBackupTask	back to summary
private void startBackupTask(Path backupDir)

org.jabref.gui.autosaveandbackup back to summary

public sealed Interface BackupManager.RestoreResult

Known Direct Implementers

permits Restored, Empty, Failed, NotFoundorg.jabref.gui.autosaveandbackup.BackupManager.RestoreResult.Restored, org.jabref.gui.autosaveandbackup.BackupManager.RestoreResult.Empty, org.jabref.gui.autosaveandbackup.BackupManager.RestoreResult.Failed, org.jabref.gui.autosaveandbackup.BackupManager.RestoreResult.NotFound

Annotations

@NullMarked

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static record	BackupManager.RestoreResult.Empty
public static record	BackupManager.RestoreResult.Failed
public static record	BackupManager.RestoreResult.NotFound
public static record	BackupManager.RestoreResult.Restored

org.jabref.gui.autosaveandbackup back to summary

public final Record BackupManager.RestoreResult.Empty

Class Inheritance

extends Record
implements RestoreResult

java.lang.Object
java.lang.Record
org.jabref.gui.autosaveandbackup.BackupManager.RestoreResult.Empty

All Implemented Interfaces

org.jabref.gui.autosaveandbackup.BackupManager.RestoreResult

Record Components

backupPath:Path

Field Summary

Modifier and Type	Field and Description
private final Path	backupPath Record Component accessed by backupPath().

Constructor Summary

Access	Constructor and Description
public	Empty(Path backupPath)

Method Summary

Modifier and Type	Method and Description
public Path	backupPath() Record Component getter of backupPath.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

backupPath	back to summary
private final Path backupPath Record Component accessed by backupPath().

Constructor Detail

Empty	back to summary
public Empty(Path backupPath)

Method Detail

backupPath	back to summary
public Path backupPath() Record Component getter of backupPath.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

org.jabref.gui.autosaveandbackup back to summary

public final Record BackupManager.RestoreResult.Failed

Class Inheritance

extends Record
implements RestoreResult

java.lang.Object
java.lang.Record
org.jabref.gui.autosaveandbackup.BackupManager.RestoreResult.Failed

All Implemented Interfaces

org.jabref.gui.autosaveandbackup.BackupManager.RestoreResult

Record Components

backupPath:Path
exception:IOException

Field Summary

Modifier and Type	Field and Description
private final Path	backupPath Record Component accessed by backupPath().
private final IOException	exception Record Component accessed by exception().

Constructor Summary

Access	Constructor and Description
public	Failed(Path backupPath, IOException exception)

Method Summary

Modifier and Type	Method and Description
public Path	backupPath() Record Component getter of backupPath.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public IOException	exception() Record Component getter of exception.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

backupPath	back to summary
private final Path backupPath Record Component accessed by backupPath().

exception	back to summary
private final IOException exception Record Component accessed by exception().

Constructor Detail

Failed	back to summary
public Failed(Path backupPath, IOException exception)

Method Detail

backupPath	back to summary
public Path backupPath() Record Component getter of backupPath.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

exception	back to summary
public IOException exception() Record Component getter of exception.

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

org.jabref.gui.autosaveandbackup back to summary

public final Record BackupManager.RestoreResult.NotFound

Class Inheritance

extends Record
implements RestoreResult

java.lang.Object
java.lang.Record
org.jabref.gui.autosaveandbackup.BackupManager.RestoreResult.NotFound

All Implemented Interfaces

org.jabref.gui.autosaveandbackup.BackupManager.RestoreResult

Record Components

originalPath:Path

Field Summary

Modifier and Type	Field and Description
private final Path	originalPath Record Component accessed by originalPath().

Constructor Summary

Access	Constructor and Description
public	NotFound(Path originalPath)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public Path	originalPath() Record Component getter of originalPath.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

originalPath	back to summary
private final Path originalPath Record Component accessed by originalPath().

Constructor Detail

NotFound	back to summary
public NotFound(Path originalPath)

Method Detail

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

originalPath	back to summary
public Path originalPath() Record Component getter of originalPath.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

org.jabref.gui.autosaveandbackup back to summary

public final Record BackupManager.RestoreResult.Restored

Class Inheritance

extends Record
implements RestoreResult

java.lang.Object
java.lang.Record
org.jabref.gui.autosaveandbackup.BackupManager.RestoreResult.Restored

All Implemented Interfaces

org.jabref.gui.autosaveandbackup.BackupManager.RestoreResult

Record Components

no record components

Constructor Summary

Access	Constructor and Description
public	Restored()

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Constructor Detail

Restored	back to summary
public Restored()

Method Detail

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

public Class BackupManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public sealed Interface BackupManager.RestoreResult

Nested and Inner Type Summary

public final Record BackupManager.RestoreResult.Empty

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record BackupManager.RestoreResult.Failed

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record BackupManager.RestoreResult.NotFound

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record BackupManager.RestoreResult.Restored

Constructor Summary

Method Summary

Constructor Detail

Method Detail