Module org.eclipse.jgit
Package org.eclipse.jgit.internal.storage.dfs

Class DfsPackFile

java.lang.Object
org.eclipse.jgit.internal.storage.dfs.DfsPackFile
public final class DfsPackFile extends Object
A Git version 2 pack file representation. A pack file contains Git objects in delta packed format yielding high compression of lots of object where some objects are similar.

  • Field Details

    • DEFAULT_BITMAP_LOADER

      public static final DfsPackFile.PackBitmapIndexLoader DEFAULT_BITMAP_LOADER
      Loader for the default file-based PackBitmapIndex implementation.

    • invalidatingCause

      protected volatile Exception invalidatingCause
      Exception that caused the packfile to be flagged as invalid

  • Constructor Details

    • DfsPackFile

      public DfsPackFile(DfsBlockCache cache, DfsPackDescription desc, DfsPackFile.PackBitmapIndexLoader bitmapLoader)
      Create an instance of DfsPackFile with a custom bitmap loader
      Parameters:
      cache - cache that owns the pack data
      desc - description of the pack within the DFS
      bitmapLoader - loader to get the bitmaps of this pack (if any)

  • Method Details

    • getPackDescription

      public DfsPackDescription getPackDescription()
      Get description that was originally used to configure this pack file.
      Returns:
      description that was originally used to configure this pack file.

    • isIndexLoaded

      public boolean isIndexLoaded()
      Whether the pack index file is loaded and cached in memory.
      Returns:
      whether the pack index file is loaded and cached in memory.

    • getPackIndex

      public PackIndex getPackIndex(DfsReader ctx) throws IOException
      Get the PackIndex for this PackFile.
      Parameters:
      ctx - reader context to support reading from the backing store if the index is not already loaded in memory.
      Returns:
      the PackIndex.
      Throws:
      IOException - the pack index is not available, or is corrupt.

    • getBitmapIndex

      public PackBitmapIndex getBitmapIndex(DfsReader ctx) throws IOException
      Get the BitmapIndex for this PackFile.
      Parameters:
      ctx - reader context to support reading from the backing store if the index is not already loaded in memory.
      Returns:
      the BitmapIndex.
      Throws:
      IOException - the bitmap index is not available, or is corrupt.

    • getCommitGraph

      public CommitGraph getCommitGraph(DfsReader ctx) throws IOException
      Get the Commit Graph for this PackFile.
      Parameters:
      ctx - reader context to support reading from the backing store if the index is not already loaded in memory.
      Returns:
      CommitGraph, null if pack doesn't have it.
      Throws:
      IOException - the Commit Graph is not available, or is corrupt.

    • getReverseIdx

      public PackReverseIndex getReverseIdx(DfsReader ctx) throws IOException
      Get the PackReverseIndex for this PackFile.
      Parameters:
      ctx - reader context to support reading from the backing store if the index is not already loaded in memory
      Returns:
      the PackReverseIndex
      Throws:
      IOException - the pack index is not available, or is corrupt

    • hasObject

      public boolean hasObject(DfsReader ctx, AnyObjectId id) throws IOException
      Check if an object is stored within this pack.
      Parameters:
      ctx - reader context to support reading from the backing store if the index is not already loaded in memory.
      id - object to be located.
      Returns:
      true if the object exists in this pack; false if it does not.
      Throws:
      IOException - the pack index is not available, or is corrupt.