JGit 7.2.0.202503040940-r · org.eclipse.jgit.api · APIdia, the JavaDoc alternative

Package org.eclipse.jgit.api

High-level API commands (the porcelain of JGit).

Interface Summary

Modifier and Type	Interface and Description
public interface	CherryPickCommitMessageProvider The interface is used to construct a cherry-picked commit message based on the original commit
public interface	TransportConfigCallback Receives a callback allowing type-specific configuration to be set on the Transport instance after it's been created.
public interface	VerificationResult A `VerificationResult` describes the outcome of a signature verification.

Class Summary

Modifier and Type	Class and Description
public class	AddCommand A class used to execute a `Add` command.
public class	AddNoteCommand Add object notes.
public class	ApplyCommand Apply a patch to files and/or to the index.
public class	ApplyResult Encapsulates the result of a `org.eclipse.jgit.api.ApplyCommand`
public class	ArchiveCommand Create an archive of files from a named tree.
public class	BlameCommand Blame command for building a `org.eclipse.jgit.blame.BlameResult` for a file path.
public class	CheckoutCommand Checkout a branch to the working tree.
public class	CheckoutResult Encapsulates the result of a `org.eclipse.jgit.api.CheckoutCommand`
public class	CherryPickCommand A class used to execute a `cherry-pick` command.
public class	CherryPickResult Encapsulates the result of a `org.eclipse.jgit.api.CherryPickCommand`.
public class	CleanCommand Remove untracked files from the working tree
public class	CloneCommand Clone a repository into a new working directory
public class	CommitCommand A class used to execute a `Commit` command.
public class	CreateBranchCommand Used to create a local branch.
public class	DeleteBranchCommand Used to delete one or several branches.
public class	DeleteTagCommand Used to delete one or several tags.
public class	DescribeCommand Given a commit, show the most recent tag that is reachable from a commit.
public class	DiffCommand Show changes between commits, commit and working tree, etc.
public class	FetchCommand A class used to execute a `Fetch` command.
public class	GarbageCollectCommand A class used to execute a `gc` command.
public class	Git Offers a "GitPorcelain"-like API to interact with a git repository.
public abstract class	GitCommand< the return type which is expected from `call()` T> Common superclass of all commands in the package `org.eclipse.jgit.api` This class ensures that all commands fulfill the `java.util.concurrent.Callable` interface.
public class	InitCommand Create an empty git repository or reinitalize an existing one
public class	ListBranchCommand Used to obtain a list of branches.
public class	ListNotesCommand List object notes.
public class	ListTagCommand Used to obtain a list of tags.
public class	LogCommand A class used to execute a `Log` command.
public class	LsRemoteCommand The ls-remote command
public class	MergeCommand A class used to execute a `Merge` command.
public class	MergeResult Encapsulates the result of a `org.eclipse.jgit.api.MergeCommand`.
public class	NameRevCommand Command to find human-readable names of revisions.
public class	PackRefsCommand Optimize storage of references.
public class	PullCommand The Pull command
public class	PullResult Encapsulates the result of a `org.eclipse.jgit.api.PullCommand`
public class	PushCommand A class used to execute a `Push` command.
public class	RebaseCommand A class used to execute a `Rebase` command.
public class	RebaseResult The result of a `org.eclipse.jgit.api.RebaseCommand` execution
public class	ReflogCommand The reflog command
public class	RemoteAddCommand Used to add a new remote.
public class	RemoteListCommand Used to obtain the list of remotes.
public class	RemoteRemoveCommand Used to remove an existing remote.
public class	RemoteSetUrlCommand Used to change the URL of a remote.
public class	RemoveNoteCommand Remove object notes.
public class	RenameBranchCommand Used to rename branches.
public class	ResetCommand A class used to execute a `Reset` command.
public class	RevertCommand A class used to execute a `revert` command.
public class	RmCommand Remove files from the index and working directory (or optionally only from the index).
public class	ShowNoteCommand Show an object note.
public class	StashApplyCommand Command class to apply a stashed commit.
public class	StashCreateCommand Command class to stash changes in the working directory and index in a commit.
public class	StashDropCommand Command class to delete a stashed commit reference Currently only supported on a traditional file repository using one-file-per-ref reflogs.
public class	StashListCommand Command class to list the stashed commits in a repository.
public class	Status A class telling where the working-tree, the index and the current HEAD differ from each other.
public class	StatusCommand A class used to execute a `Status` command.
public class	SubmoduleAddCommand A class used to execute a submodule add command.
public class	SubmoduleDeinitCommand A class used to execute a submodule deinit command.
public class	SubmoduleDeinitResult The result of a submodule deinit command for a particular path
public class	SubmoduleInitCommand A class used to execute a submodule init command.
public class	SubmoduleStatusCommand A class used to execute a submodule status command.
public class	SubmoduleSyncCommand A class used to execute a submodule sync command.
public class	SubmoduleUpdateCommand A class used to execute a submodule update command.
public class	TagCommand Create/update an annotated tag object or a simple unannotated tag Examples (`git` is a `org.eclipse.jgit.api.Git` instance): Create a new tag for the current commit: git.tag().setName("v1.0").setMessage("First stable release").call();
public abstract class	TransportCommand< concrete type of this `GitCommand` C extends GitCommand<T>, the return type of the `GitCommand`'s `call()` method T> Base class for commands that use a `org.eclipse.jgit.transport.Transport` during execution.
public class	VerifySignatureCommand A command to verify GPG signatures on tags or commits.