org.jabref.gui.git

public Class GitCommitDialogViewModel

Class Inheritance

extends AbstractViewModel

java.lang.Object
org.jabref.gui.AbstractViewModel
org.jabref.gui.git.GitCommitDialogViewModel

Annotations

@NullMarked

Imports

java.io.IOException, java.nio.file.Path, java.util.Optional, javafx.beans.property.BooleanProperty, .SimpleBooleanProperty, .SimpleStringProperty, .StringProperty, org.jabref.gui.AbstractViewModel, .DialogService, .StateManager, org.jabref.logic.JabRefException, org.jabref.logic.git.GitHandler, .GitSyncService, org.jabref.logic.git.diff.GitDiffChecker, org.jabref.logic.git.model.PushResult, org.jabref.logic.git.status.GitStatusChecker, .GitStatusSnapshot, org.jabref.logic.git.util.GitExceptionUtil, .GitHandlerRegistry, org.jabref.logic.importer.ImportFormatPreferences, org.jabref.logic.l10n.Localization, org.jabref.logic.util.BackgroundTask, .TaskExecutor, org.jabref.logic.util.strings.StringUtil, org.jabref.model.database.BibDatabaseContext, org.jabref.model.util.FileUpdateMonitor, de.saxsys.mvvmfx.utils.validation.FunctionBasedValidator, de.saxsys.mvvmfx.utils.validation.ValidationMessage, de.saxsys.mvvmfx.utils.validation.ValidationStatus, de.saxsys.mvvmfx.utils.validation.Validator, org.eclipse.jgit.api.errors.GitAPIException, org.jspecify.annotations.NullMarked, org.slf4j.Logger, .LoggerFactory

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static enum	GitCommitDialogViewModel.CommitOutcome What a finished dialog action actually achieved, so the user can be told the truth about it.
public static record	GitCommitDialogViewModel.DiffDatabases
private static class	GitCommitDialogViewModel.PushFailedException
private static record	GitCommitDialogViewModel.ResolvedRepository
private static record	GitCommitDialogViewModel.TrackedFile

Field Summary

Modifier and Type	Field and Description
private final BooleanProperty	amend
private final StringProperty	commitMessage
private final de.saxsys.mvvmfx.utils.validation.Validator	commitMessageValidator
private final DialogService	dialogService
private final FileUpdateMonitor	fileUpdateMonitor
private final GitHandlerRegistry	gitHandlerRegistry
private final ImportFormatPreferences	importFormatPreferences
private static final Logger	LOGGER
private final StateManager	stateManager
private final TaskExecutor	taskExecutor

Constructor Summary

Access	Constructor and Description
public	GitCommitDialogViewModel(StateManager stateManager, DialogService dialogService, TaskExecutor taskExecutor, GitHandlerRegistry gitHandlerRegistry, ImportFormatPreferences importFormatPreferences, FileUpdateMonitor fileUpdateMonitor)

Method Summary

Modifier and Type	Method and Description
public BooleanProperty	amendProperty()
public void	commit(Runnable onSuccess)
private void	commitAction(Runnable onSuccess, org.jabref.logic.util.BackgroundTask<GitCommitDialogViewModel.CommitOutcome> task)
public void	commitAndPush(Runnable onSuccess)
private org.jabref.logic.util.BackgroundTask<GitCommitDialogViewModel.CommitOutcome>	commitAndPushTask()
private boolean	commitCurrent(GitCommitDialogViewModel.ResolvedRepository repository)
private String	commitMessageOrDefault()
public StringProperty	commitMessageProperty()
public de.saxsys.mvvmfx.utils.validation.ValidationStatus	commitMessageValidation()
private void	commitOn(GitCommitDialogViewModel.ResolvedRepository repository)
private org.jabref.logic.util.BackgroundTask<GitCommitDialogViewModel.CommitOutcome>	commitTask()
private GitCommitDialogViewModel.DiffDatabases	computeDiffDatabases()
public org.jabref.logic.util.BackgroundTask<GitCommitDialogViewModel.DiffDatabases>	diffTask()
private void	doCommit()
private GitCommitDialogViewModel.CommitOutcome	doCommitAndPush()
private GitCommitDialogViewModel.TrackedFile	getTrackedBibFile()
private String	localizedFailureMessage(Throwable throwable)
private String	messageFor(GitCommitDialogViewModel.CommitOutcome outcome)
private GitCommitDialogViewModel.CommitOutcome	pushTo(GitCommitDialogViewModel.ResolvedRepository repository, boolean committedNow)
private GitCommitDialogViewModel.ResolvedRepository	resolveRepository()

Field Detail

amend	back to summary
private final BooleanProperty amend

commitMessage	back to summary
private final StringProperty commitMessage

commitMessageValidator	back to summary
private final de.saxsys.mvvmfx.utils.validation.Validator commitMessageValidator

dialogService	back to summary
private final DialogService dialogService

fileUpdateMonitor	back to summary
private final FileUpdateMonitor fileUpdateMonitor

gitHandlerRegistry	back to summary
private final GitHandlerRegistry gitHandlerRegistry

importFormatPreferences	back to summary
private final ImportFormatPreferences importFormatPreferences

LOGGER	back to summary
private static final Logger LOGGER

stateManager	back to summary
private final StateManager stateManager

taskExecutor	back to summary
private final TaskExecutor taskExecutor

Constructor Detail

GitCommitDialogViewModel	back to summary
public GitCommitDialogViewModel(StateManager stateManager, DialogService dialogService, TaskExecutor taskExecutor, GitHandlerRegistry gitHandlerRegistry, ImportFormatPreferences importFormatPreferences, FileUpdateMonitor fileUpdateMonitor)

Method Detail

amendProperty	back to summary
public BooleanProperty amendProperty()

commit	back to summary
public void commit(Runnable onSuccess)

commitAction	back to summary
private void commitAction(Runnable onSuccess, org.jabref.logic.util.BackgroundTask<GitCommitDialogViewModel.CommitOutcome> task)

commitAndPush	back to summary
public void commitAndPush(Runnable onSuccess)

commitAndPushTask	back to summary
private org.jabref.logic.util.BackgroundTask<GitCommitDialogViewModel.CommitOutcome> commitAndPushTask()

commitCurrent	back to summary
private boolean commitCurrent(GitCommitDialogViewModel.ResolvedRepository repository) throws GitAPIException, IOException

commitMessageOrDefault	back to summary
private String commitMessageOrDefault()

commitMessageProperty	back to summary
public StringProperty commitMessageProperty()

commitMessageValidation	back to summary
public de.saxsys.mvvmfx.utils.validation.ValidationStatus commitMessageValidation()

commitOn	back to summary
private void commitOn(GitCommitDialogViewModel.ResolvedRepository repository) throws org.jabref.logic.JabRefException, GitAPIException, IOException

commitTask	back to summary
private org.jabref.logic.util.BackgroundTask<GitCommitDialogViewModel.CommitOutcome> commitTask()

computeDiffDatabases	back to summary
private GitCommitDialogViewModel.DiffDatabases computeDiffDatabases() throws org.jabref.logic.JabRefException, IOException

diffTask	back to summary
public org.jabref.logic.util.BackgroundTask<GitCommitDialogViewModel.DiffDatabases> diffTask()

doCommit	back to summary
private void doCommit() throws org.jabref.logic.JabRefException, GitAPIException, IOException

doCommitAndPush	back to summary
private GitCommitDialogViewModel.CommitOutcome doCommitAndPush() throws org.jabref.logic.JabRefException, GitAPIException, IOException

getTrackedBibFile	back to summary
private GitCommitDialogViewModel.TrackedFile getTrackedBibFile() throws org.jabref.logic.JabRefException

localizedFailureMessage	back to summary
private String localizedFailureMessage(Throwable throwable)

messageFor	back to summary
private String messageFor(GitCommitDialogViewModel.CommitOutcome outcome)

pushTo	back to summary
private GitCommitDialogViewModel.CommitOutcome pushTo(GitCommitDialogViewModel.ResolvedRepository repository, boolean committedNow) throws PushFailedException

resolveRepository	back to summary
private GitCommitDialogViewModel.ResolvedRepository resolveRepository() throws org.jabref.logic.JabRefException

org.jabref.gui.git back to summary

private final Enum GitCommitDialogViewModel.CommitOutcome

Class Inheritance

extends Enum<GitCommitDialogViewModel.CommitOutcome>

java.lang.Object
java.lang.Enum
org.jabref.gui.git.GitCommitDialogViewModel.CommitOutcome

What a finished dialog action actually achieved, so the user can be told the truth about it.

Field Summary

Modifier and Type	Field and Description
public static final GitCommitDialogViewModel.CommitOutcome	COMMITTED
public static final GitCommitDialogViewModel.CommitOutcome	COMMITTED_AND_PUSHED
public static final GitCommitDialogViewModel.CommitOutcome	NOTHING_TO_PUSH
public static final GitCommitDialogViewModel.CommitOutcome	PUSHED

Constructor Summary

Access	Constructor and Description
private	CommitOutcome()

Method Summary

Modifier and Type	Method and Description
public static GitCommitDialogViewModel.CommitOutcome	valueOf(String name)
public static GitCommitDialogViewModel.CommitOutcome[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COMMITTED	back to summary
public static final GitCommitDialogViewModel.CommitOutcome COMMITTED

COMMITTED_AND_PUSHED	back to summary
public static final GitCommitDialogViewModel.CommitOutcome COMMITTED_AND_PUSHED

NOTHING_TO_PUSH	back to summary
public static final GitCommitDialogViewModel.CommitOutcome NOTHING_TO_PUSH

PUSHED	back to summary
public static final GitCommitDialogViewModel.CommitOutcome PUSHED

Constructor Detail

CommitOutcome	back to summary
private CommitOutcome()

Method Detail

valueOf	back to summary
public static GitCommitDialogViewModel.CommitOutcome valueOf(String name)

values	back to summary
public static GitCommitDialogViewModel.CommitOutcome[] values()

org.jabref.gui.git back to summary

public final Record GitCommitDialogViewModel.DiffDatabases

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.gui.git.GitCommitDialogViewModel.DiffDatabases

Record Components

headDatabase:BibDatabaseContext
workingTreeDatabase:BibDatabaseContext

Field Summary

Modifier and Type	Field and Description
private final BibDatabaseContext	headDatabase Record Component accessed by headDatabase().
private final BibDatabaseContext	workingTreeDatabase Record Component accessed by workingTreeDatabase().

Constructor Summary

Access	Constructor and Description
public	DiffDatabases(BibDatabaseContext headDatabase, BibDatabaseContext workingTreeDatabase)

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 BibDatabaseContext	headDatabase() Record Component getter of headDatabase.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public BibDatabaseContext	workingTreeDatabase() Record Component getter of workingTreeDatabase.

Field Detail

headDatabase	back to summary
private final BibDatabaseContext headDatabase Record Component accessed by headDatabase().

workingTreeDatabase	back to summary
private final BibDatabaseContext workingTreeDatabase Record Component accessed by workingTreeDatabase().

Constructor Detail

DiffDatabases	back to summary
public DiffDatabases(BibDatabaseContext headDatabase, BibDatabaseContext workingTreeDatabase)

Method Detail

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).

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.

headDatabase	back to summary
public BibDatabaseContext headDatabase() Record Component getter of headDatabase.

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.

workingTreeDatabase	back to summary
public BibDatabaseContext workingTreeDatabase() Record Component getter of workingTreeDatabase.

org.jabref.gui.git back to summary

private Class GitCommitDialogViewModel.PushFailedException

Class Inheritance

extends JabRefException

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.jabref.logic.JabRefException
org.jabref.gui.git.GitCommitDialogViewModel.PushFailedException

Constructor Summary

Access	Constructor and Description
pack-priv	PushFailedException(Throwable cause, boolean committedNow) Claiming "the commit was saved" is only honest when this attempt actually created one: the push may also fail with nothing newly committed (e.g. retrying after a failed push).

Method Summary

Modifier and Type	Method and Description
private static String	causeMessage(Throwable cause)

Constructor Detail

PushFailedException	back to summary
pack-priv PushFailedException(Throwable cause, boolean committedNow) Claiming "the commit was saved" is only honest when this attempt actually created one: the push may also fail with nothing newly committed (e.g. retrying after a failed push).

Method Detail

causeMessage	back to summary
private static String causeMessage(Throwable cause)

org.jabref.gui.git back to summary

private final Record GitCommitDialogViewModel.ResolvedRepository

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.gui.git.GitCommitDialogViewModel.ResolvedRepository

Record Components

database:BibDatabaseContext
bibFilePath:Path
gitHandler:GitHandler

Field Summary

Modifier and Type	Field and Description
private final Path	bibFilePath Record Component accessed by bibFilePath().
private final BibDatabaseContext	database Record Component accessed by database().
private final GitHandler	gitHandler Record Component accessed by gitHandler().

Constructor Summary

Access	Constructor and Description
private	ResolvedRepository(BibDatabaseContext database, Path bibFilePath, GitHandler gitHandler)

Method Summary

Modifier and Type	Method and Description
public Path	bibFilePath() Record Component getter of bibFilePath.
public BibDatabaseContext	database() Record Component getter of database.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public GitHandler	gitHandler() Record Component getter of gitHandler.
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

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

database	back to summary
private final BibDatabaseContext database Record Component accessed by database().

gitHandler	back to summary
private final GitHandler gitHandler Record Component accessed by gitHandler().

Constructor Detail

ResolvedRepository	back to summary
private ResolvedRepository(BibDatabaseContext database, Path bibFilePath, GitHandler gitHandler)

Method Detail

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

database	back to summary
public BibDatabaseContext database() Record Component getter of database.

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).

gitHandler	back to summary
public GitHandler gitHandler() Record Component getter of gitHandler.

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.git back to summary

private final Record GitCommitDialogViewModel.TrackedFile

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.gui.git.GitCommitDialogViewModel.TrackedFile

Record Components

gitHandler:GitHandler
bibFilePath:Path

Field Summary

Modifier and Type	Field and Description
private final Path	bibFilePath Record Component accessed by bibFilePath().
private final GitHandler	gitHandler Record Component accessed by gitHandler().

Constructor Summary

Access	Constructor and Description
private	TrackedFile(GitHandler gitHandler, Path bibFilePath)

Method Summary

Modifier and Type	Method and Description
public Path	bibFilePath() Record Component getter of bibFilePath.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public GitHandler	gitHandler() Record Component getter of gitHandler.
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

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

gitHandler	back to summary
private final GitHandler gitHandler Record Component accessed by gitHandler().

Constructor Detail

TrackedFile	back to summary
private TrackedFile(GitHandler gitHandler, Path bibFilePath)

Method Detail

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

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).

gitHandler	back to summary
public GitHandler gitHandler() Record Component getter of gitHandler.

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.