Top Fields Constructors Methods

org.jabref.gui.git

public Class GitCommitAction

Class Inheritance

extends SimpleCommand

java.lang.Object
⋱
de.saxsys.mvvmfx.utils.commands.CommandBase
org.jabref.gui.actions.SimpleCommand
org.jabref.gui.git.GitCommitAction

Annotations

@NullMarked

Imports

java.nio.file.Path, java.util.Optional, java.util.function.Supplier, javafx.scene.control.Alert, .ButtonBar, .ButtonType, org.jabref.gui.DialogService, .LibraryTab, .StateManager, org.jabref.gui.actions.ActionHelper, .SimpleCommand, org.jabref.gui.exporter.SaveDatabaseAction, .SaveDatabaseAction.SaveDatabaseMode, .SaveDatabaseAction.SaveResult, org.jabref.gui.preferences.GuiPreferences, org.jabref.logic.JabRefException, org.jabref.logic.git.GitHandler, org.jabref.logic.git.status.GitStatusChecker, org.jabref.logic.git.util.GitHandlerRegistry, org.jabref.logic.journals.JournalAbbreviationRepository, org.jabref.logic.l10n.Localization, org.jabref.logic.util.BackgroundTask, .TaskExecutor, org.jabref.model.database.BibDatabaseContext, org.jabref.model.entry.BibEntryTypesManager, org.jspecify.annotations.NullMarked, .Nullable, org.slf4j.Logger, .LoggerFactory

Field Summary

Modifier and Type	Field and Description
private final DialogService	dialogService
private final BibEntryTypesManager	entryTypesManager
private final GitHandlerRegistry	gitHandlerRegistry
private final JournalAbbreviationRepository	journalAbbreviationRepository
private static final Logger	LOGGER
private final GuiPreferences	preferences
private final StateManager	stateManager
private final Supplier<@Nullable LibraryTab>	tabSupplier
private final TaskExecutor	taskExecutor

Inherited from org.jabref.gui.actions.SimpleCommand:: statusMessage

Constructor Summary

Access	Constructor and Description
public	GitCommitAction(Supplier<@Nullable LibraryTab> tabSupplier, DialogService dialogService, StateManager stateManager, GuiPreferences preferences, BibEntryTypesManager entryTypesManager, JournalAbbreviationRepository journalAbbreviationRepository, TaskExecutor taskExecutor, GitHandlerRegistry gitHandlerRegistry)

Method Summary

Modifier and Type	Method and Description
private void	commit(Path bibFilePath)
private boolean	commitWithUnsavedChanges(LibraryTab libraryTab) Without autosave the user decides when the library is written, so committing only the work already on disk stays available, as in other Git clients.
public void	execute()
private boolean	hasNothingToCommit(Path bibFilePath)
private void	initRepository(Path libraryFile) Offers to put a library that is not under version control into a fresh repository.
private boolean	isReadyToCommit()
private boolean	save(LibraryTab libraryTab) The save must not commit by itself: this one is on its way to the commit dialog.

Inherited from org.jabref.gui.actions.SimpleCommand:: getProgress progressProperty setExecutable statusMessageProperty

Field Detail

dialogService	back to summary
private final DialogService dialogService

entryTypesManager	back to summary
private final BibEntryTypesManager entryTypesManager

gitHandlerRegistry	back to summary
private final GitHandlerRegistry gitHandlerRegistry

journalAbbreviationRepository	back to summary
private final JournalAbbreviationRepository journalAbbreviationRepository

LOGGER	back to summary
private static final Logger LOGGER

preferences	back to summary
private final GuiPreferences preferences

stateManager	back to summary
private final StateManager stateManager

tabSupplier	back to summary
private final Supplier<@Nullable LibraryTab> tabSupplier

taskExecutor	back to summary
private final TaskExecutor taskExecutor

Constructor Detail

GitCommitAction	back to summary
public GitCommitAction(Supplier<@Nullable LibraryTab> tabSupplier, DialogService dialogService, StateManager stateManager, GuiPreferences preferences, BibEntryTypesManager entryTypesManager, JournalAbbreviationRepository journalAbbreviationRepository, TaskExecutor taskExecutor, GitHandlerRegistry gitHandlerRegistry)

Method Detail

commit	back to summary
private void commit(Path bibFilePath)

commitWithUnsavedChanges	back to summary
private boolean commitWithUnsavedChanges(LibraryTab libraryTab) Without autosave the user decides when the library is written, so committing only the work already on disk stays available, as in other Git clients. `impl->req~git.commit.unsaved-changes~1`

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

hasNothingToCommit	back to summary
private boolean hasNothingToCommit(Path bibFilePath) throws org.jabref.logic.JabRefException

initRepository	back to summary
private void initRepository(Path libraryFile) Offers to put a library that is not under version control into a fresh repository. Cancelling is a valid choice: the user may want to clone an existing repository into that folder instead.

isReadyToCommit	back to summary
private boolean isReadyToCommit()

save	back to summary
private boolean save(LibraryTab libraryTab) The save must not commit by itself: this one is on its way to the commit dialog.