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

Package org.eclipse.jgit.lib

Core API for repository, config, refs, object database.

Interface Summary

Modifier and Type	Interface and Description
public interface	AsyncObjectLoaderQueue< type of identifier supplied to the call that made the queue. T extends ObjectId> Queue to open objects asynchronously.
public interface	AsyncObjectSizeQueue< type of identifier supplied to the call that made the queue. T extends ObjectId> Queue to examine object sizes asynchronously.
public interface	AsyncOperation Asynchronous operation handle.
public interface	BitmapIndex A compressed bitmap representation of the entire object graph.
public interface	BlobObjectChecker Verifies that a blob object is a valid object.
public interface	CheckoutEntry Parsed information about a checkout.
public interface	ObjectIdSet Simple set of ObjectIds.
public interface	ProgressMonitor A progress reporting interface.
public interface	Ref Pairing of a name and the `org.eclipse.jgit.lib.ObjectId` it currently has.
public interface	ReflogEntry Parsed reflog entry
public interface	ReflogReader Utility for reading reflog entries
public interface	RepositoryBuilderFactory A factory for `BaseRepositoryBuilder`s.
public interface	SignatureVerifier A `SignatureVerifier` can verify signatures on git commits and tags.
public interface	SignatureVerifierFactory A factory for `SignatureVerifier`s.
public interface	Signer Creates signatures for Git objects.
public interface	SignerFactory A factory for `Signer`s.
public interface	TypedConfigGetter Something that knows how to convert plain strings from a git `Config` to typed values.

Class Summary

Modifier and Type	Class and Description
public class	AbbrevConfig Git configuration option core.abbrev
public class	AbbreviatedObjectId A prefix abbreviation of an `org.eclipse.jgit.lib.ObjectId`.
public abstract class	AnyObjectId A (possibly mutable) SHA-1 abstraction.
public class	BaseRepositoryBuilder< type of the repository builder. B extends BaseRepositoryBuilder, type of the repository that is constructed. R extends Repository> Base builder to customize repository construction.
public abstract class	BatchingProgressMonitor ProgressMonitor that batches update events.
public class	BatchRefUpdate Batch of reference updates to be applied to a repository.
public abstract class	BitmapObject Base object type accessed during bitmap expansion.
public class	BlobBasedConfig Configuration file based on the blobs stored in the repository.
public class	BranchConfig Branch section of a Git configuration file.
public class	BranchTrackingStatus Status of a branch's relation to its remote-tracking branch.
public class	CommitBuilder Mutable builder to construct a commit recording the state of a project.
public class	CommitConfig The standard "commit" configuration parameters.
public class	Config Git style `.config`, `.gitconfig`, `.gitmodules` file.
public class	ConfigConstants Constants for use with the Configuration classes: section names, configuration keys
pack-priv class	ConfigLine A line in a Git `Config` file.
pack-priv class	ConfigSnapshot
public class	Constants Misc.
public class	CoreConfig This class keeps git repository core parameters.
public class	DefaultTypedConfigGetter An `org.eclipse.jgit.lib.TypedConfigGetter` that throws `java.lang.IllegalArgumentException` on invalid values.
public abstract class	EmptyProgressMonitor A convenient base class which provides empty method bodies for all ProgressMonitor methods.
public abstract class	FileMode Constants describing various file modes recognized by GIT.
public class	FileModeCache A hierarchical cache of `FileMode`s per git path.
public class	GitmoduleEntry A .gitmodules file found in the pack.
public class	GpgConfig Typed access to GPG related configuration options.
public class	GpgSignature A structure for holding GPG signature together with additional related data.
public class	IndexDiff Compares the index, a tree, and the working directory Ignored files are not taken into account.
public class	InflaterCache Creates zlib based inflaters as necessary for object decompression.
public class	MutableObjectId A mutable SHA-1 abstraction.
public class	NullProgressMonitor A NullProgressMonitor does not report progress anywhere.
public abstract class	ObjectBuilder Common base class for `CommitBuilder` and `TagBuilder`.
public class	ObjectChecker Verifies that an object is formatted correctly.
public abstract class	ObjectDatabase Abstraction of arbitrary object storage.
public class	ObjectId A SHA-1 abstraction.
public class	ObjectIdOwnerMap< type of subclass of ObjectId that will be stored in the map. V extends ObjectIdOwnerMap.Entry> Fast, efficient map for `org.eclipse.jgit.lib.ObjectId` subclasses in only one map.
public abstract class	ObjectIdRef A `org.eclipse.jgit.lib.Ref` that points directly at an `org.eclipse.jgit.lib.ObjectId`.
public class	ObjectIdSerializer Helper to serialize `ObjectId` instances.
public class	ObjectIdSubclassMap< type of subclass of ObjectId that will be stored in the map. V extends ObjectId> Fast, efficient map specifically for `org.eclipse.jgit.lib.ObjectId` subclasses.
public abstract class	ObjectInserter Inserts objects into an existing `ObjectDatabase`.
public abstract class	ObjectLoader Base class for a set of loaders for different representations of Git objects.
public abstract class	ObjectReader Reads an `org.eclipse.jgit.lib.ObjectDatabase` for a single thread.
public abstract class	ObjectStream Stream of data coming from an object loaded by `org.eclipse.jgit.lib.ObjectLoader`.
public class	PersonIdent A combination of a person identity and time in Git.
public class	RebaseTodoFile Offers methods to read and write files formatted like the git-rebase-todo file
public class	RebaseTodoLine Describes a single line in a file formatted like the git-rebase-todo file.
public class	RefComparator Util for sorting (or comparing) Ref instances by name.
public abstract class	RefDatabase Abstraction of name to `org.eclipse.jgit.lib.ObjectId` mapping.
public abstract class	RefRename A RefUpdate combination for renaming a reference.
public abstract class	RefUpdate Creates, updates or deletes any reference.
public abstract class	RefWriter Writes out refs to the `org.eclipse.jgit.lib.Constants#INFO_REFS` and `org.eclipse.jgit.lib.Constants#PACKED_REFS` files.
public abstract class	Repository Represents a Git repository.
public class	RepositoryBuilder Base class to support constructing a `org.eclipse.jgit.lib.Repository`.
public class	RepositoryCache Cache of active `org.eclipse.jgit.lib.Repository` instances.
public class	RepositoryCacheConfig Configuration parameters for JVM-wide repository cache used by JGit.
public class	SignatureVerifiers Manages the available signers.
public class	Signers Manages the available signers.
public abstract class	StoredConfig Persistent configuration that can be stored and loaded from a location.
public class	SubmoduleConfig Submodule section of a Git configuration file.
public class	SymbolicRef A reference that indirectly points at another `org.eclipse.jgit.lib.Ref`.
public class	TagBuilder Mutable builder to construct an annotated tag recording a project state.
public class	TextProgressMonitor A simple progress reporter printing on a stream.
public class	ThreadSafeProgressMonitor Wrapper around the general `org.eclipse.jgit.lib.ProgressMonitor` to make it thread safe.
public class	TreeFormatter Mutable formatter to construct a single tree object.
public class	UserConfig The standard "user" configuration parameters.

Enum Summary

Modifier and Type	Enum and Description
public enum	RepositoryState Important state of the repository that affects what can and cannot bed done.