Class ObjectDirectory
- java.lang.Object
-
- org.eclipse.jgit.lib.ObjectDatabase
-
- org.eclipse.jgit.internal.storage.file.FileObjectDatabase
-
- org.eclipse.jgit.internal.storage.file.ObjectDirectory
-
public class ObjectDirectory extends FileObjectDatabase
Traditional file system basedObjectDatabase
.This is the classical object database representation for a Git repository, where objects are stored loose by hashing them into directories by their
ObjectId
, or are stored in compressed containers known asPack
s.Optionally an object database can reference one or more alternates; other ObjectDatabase instances that are searched in addition to the current database.
Databases are divided into two halves: a half that is considered to be fast to search (the
PackFile
s), and a half that is considered to be slow to search (loose objects). When alternates are present the fast half is fully searched (recursively through all alternates) before the slow half is considered.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
ObjectDirectory.AlternateHandle
(package private) static class
ObjectDirectory.AlternateRepository
-
Nested classes/interfaces inherited from class org.eclipse.jgit.internal.storage.file.FileObjectDatabase
FileObjectDatabase.InsertLooseObjectResult
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.concurrent.atomic.AtomicReference<ObjectDirectory.AlternateHandle[]>
alternates
private java.io.File
alternatesFile
private Config
config
private FS
fs
private ObjectDirectory.AlternateHandle
handle
private java.io.File
infoDirectory
private LooseObjects
loose
private java.io.File
objects
private PackDirectory
packed
private PackDirectory
preserved
private static int
RESOLVE_ABBREV_LIMIT
Maximum number of candidates offered as resolutions of abbreviation.private java.util.Set<ObjectId>
shallowCommitsIds
private java.io.File
shallowFile
private FileSnapshot
shallowFileSnapshot
-
Constructor Summary
Constructors Constructor Description ObjectDirectory(Config cfg, java.io.File dir, java.io.File[] alternatePaths, FS fs, java.io.File shallowFile)
Initialize a reference to an on-disk object directory.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) java.util.Set<ObjectDirectory.AlternateHandle.Id>
addMe(java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
void
close()
Close any resources held by this database.(package private) void
closeAllPackHandles(java.io.File packFile)
void
create()
Initialize a new object database at this location.boolean
exists()
Does this database exist yet?java.io.File
fileFor(AnyObjectId objectId)
Compute the location of a loose object file.(package private) ObjectDirectory.AlternateHandle.Id
getAlternateId()
(package private) Config
getConfig()
java.io.File
getDirectory()
(package private) FS
getFS()
private long
getLooseSizeFromSelfOrAlternate(WindowCursor curs, AnyObjectId id, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
(package private) long
getObjectSize(WindowCursor curs, AnyObjectId id)
private long
getObjectSizeWithoutRestoring(WindowCursor curs, AnyObjectId id)
java.io.File
getPackDirectory()
Getter for the fieldpackDirectory
.private long
getPackedSizeFromSelfOrAlternate(WindowCursor curs, AnyObjectId id, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
java.util.Collection<Pack>
getPacks()
java.io.File
getPreservedDirectory()
Getter for the fieldpreservedDirectory
.(package private) java.util.Set<ObjectId>
getShallowCommits()
boolean
has(AnyObjectId objectId)
Does the requested object exist in this database?private boolean
hasLooseInSelfOrAlternate(AnyObjectId objectId, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
private boolean
hasPackedInSelfOrAlternate(AnyObjectId objectId, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
(package private) boolean
hasPackedObject(AnyObjectId objectId)
private boolean
hasPackedOrLooseInSelfOrAlternate(AnyObjectId objectId)
(package private) FileObjectDatabase.InsertLooseObjectResult
insertUnpackedObject(java.io.File tmp, ObjectId id, boolean createDuplicate)
private ObjectDirectory.AlternateHandle[]
loadAlternates()
(package private) ObjectDirectory.AlternateHandle[]
myAlternates()
ObjectDatabase
newCachedDatabase()
Create a new cached database instance over this database.(package private) CachedObjectDirectory
newCachedFileObjectDatabase()
ObjectDirectoryInserter
newInserter()
Create a newObjectInserter
to insert new objects.PackInserter
newPackInserter()
Create a new inserter that inserts all objects as pack files, not loose objects.private static java.io.BufferedReader
open(java.io.File f)
private ObjectDirectory.AlternateHandle
openAlternate(java.io.File objdir)
private ObjectDirectory.AlternateHandle
openAlternate(java.lang.String location)
private ObjectLoader
openLooseFromSelfOrAlternate(WindowCursor curs, AnyObjectId objectId, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
(package private) ObjectLoader
openLooseObject(WindowCursor curs, AnyObjectId id)
(package private) ObjectLoader
openObject(WindowCursor curs, AnyObjectId objectId)
private ObjectLoader
openObjectWithoutRestoring(WindowCursor curs, AnyObjectId objectId)
Pack
openPack(java.io.File pack)
private ObjectLoader
openPackedFromSelfOrAlternate(WindowCursor curs, AnyObjectId objectId, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
(package private) ObjectLoader
openPackedObject(WindowCursor curs, AnyObjectId objectId)
(package private) void
resolve(java.util.Set<ObjectId> matches, AbbreviatedObjectId id)
private void
resolve(java.util.Set<ObjectId> matches, AbbreviatedObjectId id, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
private boolean
restore(PackFile preservedPack)
private boolean
restoreFromSelf(AnyObjectId objectId)
private boolean
restoreFromSelfOrAlternate(AnyObjectId objectId, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
(package private) void
selectObjectRepresentation(PackWriter packer, ObjectToPack otp, WindowCursor curs)
private void
selectObjectRepresentation(PackWriter packer, ObjectToPack otp, WindowCursor curs, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
java.lang.String
toString()
-
Methods inherited from class org.eclipse.jgit.internal.storage.file.FileObjectDatabase
newReader
-
Methods inherited from class org.eclipse.jgit.lib.ObjectDatabase
open, open
-
-
-
-
Field Detail
-
RESOLVE_ABBREV_LIMIT
private static final int RESOLVE_ABBREV_LIMIT
Maximum number of candidates offered as resolutions of abbreviation.- See Also:
- Constant Field Values
-
handle
private final ObjectDirectory.AlternateHandle handle
-
config
private final Config config
-
objects
private final java.io.File objects
-
infoDirectory
private final java.io.File infoDirectory
-
loose
private final LooseObjects loose
-
packed
private final PackDirectory packed
-
preserved
private final PackDirectory preserved
-
alternatesFile
private final java.io.File alternatesFile
-
fs
private final FS fs
-
alternates
private final java.util.concurrent.atomic.AtomicReference<ObjectDirectory.AlternateHandle[]> alternates
-
shallowFile
private final java.io.File shallowFile
-
shallowFileSnapshot
private FileSnapshot shallowFileSnapshot
-
shallowCommitsIds
private java.util.Set<ObjectId> shallowCommitsIds
-
-
Constructor Detail
-
ObjectDirectory
public ObjectDirectory(Config cfg, java.io.File dir, java.io.File[] alternatePaths, FS fs, java.io.File shallowFile) throws java.io.IOException
Initialize a reference to an on-disk object directory.- Parameters:
cfg
- configuration this directory consults for write settings.dir
- the location of theobjects
directory.alternatePaths
- a list of alternate object directoriesfs
- the file system abstraction which will be necessary to perform certain file system operations.shallowFile
- file which contains IDs of shallow commits, null if shallow commits handling should be turned off- Throws:
java.io.IOException
- an alternate object cannot be opened.
-
-
Method Detail
-
getDirectory
public final java.io.File getDirectory()
- Specified by:
getDirectory
in classFileObjectDatabase
-
getPackDirectory
public final java.io.File getPackDirectory()
Getter for the field
packDirectory
.- Returns:
- the location of the
pack
directory.
-
getPreservedDirectory
public final java.io.File getPreservedDirectory()
Getter for the field
preservedDirectory
.- Returns:
- the location of the
preserved
directory.
-
exists
public boolean exists()
Does this database exist yet?- Overrides:
exists
in classObjectDatabase
- Returns:
- true if this database is already created; false if the caller
should invoke
ObjectDatabase.create()
to create this database location.
-
create
public void create() throws java.io.IOException
Initialize a new object database at this location.- Overrides:
create
in classObjectDatabase
- Throws:
java.io.IOException
- the database could not be created.
-
newInserter
public ObjectDirectoryInserter newInserter()
Create a newObjectInserter
to insert new objects.The returned inserter is not itself thread-safe, but multiple concurrent inserter instances created from the same
ObjectDatabase
must be thread-safe.- Overrides:
newInserter
in classFileObjectDatabase
- Returns:
- writer the caller can use to create objects in this database.
-
newPackInserter
public PackInserter newPackInserter()
Create a new inserter that inserts all objects as pack files, not loose objects.- Returns:
- new inserter.
-
close
public void close()
Close any resources held by this database.- Specified by:
close
in classObjectDatabase
-
getPacks
public java.util.Collection<Pack> getPacks()
- Specified by:
getPacks
in classFileObjectDatabase
-
openPack
public Pack openPack(java.io.File pack) throws java.io.IOException
Add a single existing pack to the list of available pack files.
- Specified by:
openPack
in classFileObjectDatabase
- Throws:
java.io.IOException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
has
public boolean has(AnyObjectId objectId)
Does the requested object exist in this database?This is a one-shot call interface which may be faster than allocating a
ObjectDatabase.newReader()
to perform the lookup.- Overrides:
has
in classObjectDatabase
- Parameters:
objectId
- identity of the object to test for existence of.- Returns:
- true if the specified object is stored in this database.
-
hasPackedOrLooseInSelfOrAlternate
private boolean hasPackedOrLooseInSelfOrAlternate(AnyObjectId objectId)
-
hasPackedInSelfOrAlternate
private boolean hasPackedInSelfOrAlternate(AnyObjectId objectId, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
-
hasLooseInSelfOrAlternate
private boolean hasLooseInSelfOrAlternate(AnyObjectId objectId, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
-
hasPackedObject
boolean hasPackedObject(AnyObjectId objectId)
-
resolve
void resolve(java.util.Set<ObjectId> matches, AbbreviatedObjectId id) throws java.io.IOException
- Specified by:
resolve
in classFileObjectDatabase
- Throws:
java.io.IOException
-
resolve
private void resolve(java.util.Set<ObjectId> matches, AbbreviatedObjectId id, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips) throws java.io.IOException
- Throws:
java.io.IOException
-
openObject
ObjectLoader openObject(WindowCursor curs, AnyObjectId objectId) throws java.io.IOException
- Specified by:
openObject
in classFileObjectDatabase
- Throws:
java.io.IOException
-
openObjectWithoutRestoring
private ObjectLoader openObjectWithoutRestoring(WindowCursor curs, AnyObjectId objectId) throws java.io.IOException
- Throws:
java.io.IOException
-
openPackedFromSelfOrAlternate
private ObjectLoader openPackedFromSelfOrAlternate(WindowCursor curs, AnyObjectId objectId, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
-
openLooseFromSelfOrAlternate
private ObjectLoader openLooseFromSelfOrAlternate(WindowCursor curs, AnyObjectId objectId, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips) throws java.io.IOException
- Throws:
java.io.IOException
-
openPackedObject
ObjectLoader openPackedObject(WindowCursor curs, AnyObjectId objectId)
-
openLooseObject
ObjectLoader openLooseObject(WindowCursor curs, AnyObjectId id) throws java.io.IOException
- Specified by:
openLooseObject
in classFileObjectDatabase
- Throws:
java.io.IOException
-
getObjectSize
long getObjectSize(WindowCursor curs, AnyObjectId id) throws java.io.IOException
- Specified by:
getObjectSize
in classFileObjectDatabase
- Throws:
java.io.IOException
-
getObjectSizeWithoutRestoring
private long getObjectSizeWithoutRestoring(WindowCursor curs, AnyObjectId id) throws java.io.IOException
- Throws:
java.io.IOException
-
getPackedSizeFromSelfOrAlternate
private long getPackedSizeFromSelfOrAlternate(WindowCursor curs, AnyObjectId id, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
-
getLooseSizeFromSelfOrAlternate
private long getLooseSizeFromSelfOrAlternate(WindowCursor curs, AnyObjectId id, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips) throws java.io.IOException
- Throws:
java.io.IOException
-
selectObjectRepresentation
void selectObjectRepresentation(PackWriter packer, ObjectToPack otp, WindowCursor curs) throws java.io.IOException
- Specified by:
selectObjectRepresentation
in classFileObjectDatabase
- Throws:
java.io.IOException
-
selectObjectRepresentation
private void selectObjectRepresentation(PackWriter packer, ObjectToPack otp, WindowCursor curs, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips) throws java.io.IOException
- Throws:
java.io.IOException
-
restoreFromSelfOrAlternate
private boolean restoreFromSelfOrAlternate(AnyObjectId objectId, java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
-
restoreFromSelf
private boolean restoreFromSelf(AnyObjectId objectId)
-
restore
private boolean restore(PackFile preservedPack)
-
insertUnpackedObject
FileObjectDatabase.InsertLooseObjectResult insertUnpackedObject(java.io.File tmp, ObjectId id, boolean createDuplicate) throws java.io.IOException
- Specified by:
insertUnpackedObject
in classFileObjectDatabase
- Throws:
java.io.IOException
-
getConfig
Config getConfig()
- Specified by:
getConfig
in classFileObjectDatabase
-
getFS
FS getFS()
- Specified by:
getFS
in classFileObjectDatabase
-
getShallowCommits
java.util.Set<ObjectId> getShallowCommits() throws java.io.IOException
- Specified by:
getShallowCommits
in classFileObjectDatabase
- Throws:
java.io.IOException
-
closeAllPackHandles
void closeAllPackHandles(java.io.File packFile)
-
myAlternates
ObjectDirectory.AlternateHandle[] myAlternates()
-
addMe
java.util.Set<ObjectDirectory.AlternateHandle.Id> addMe(java.util.Set<ObjectDirectory.AlternateHandle.Id> skips)
-
loadAlternates
private ObjectDirectory.AlternateHandle[] loadAlternates() throws java.io.IOException
- Throws:
java.io.IOException
-
open
private static java.io.BufferedReader open(java.io.File f) throws java.io.IOException, java.io.FileNotFoundException
- Throws:
java.io.IOException
java.io.FileNotFoundException
-
openAlternate
private ObjectDirectory.AlternateHandle openAlternate(java.lang.String location) throws java.io.IOException
- Throws:
java.io.IOException
-
openAlternate
private ObjectDirectory.AlternateHandle openAlternate(java.io.File objdir) throws java.io.IOException
- Throws:
java.io.IOException
-
fileFor
public java.io.File fileFor(AnyObjectId objectId)
Compute the location of a loose object file.- Specified by:
fileFor
in classFileObjectDatabase
-
newCachedDatabase
public ObjectDatabase newCachedDatabase()
Create a new cached database instance over this database. This instance might optimize queries by caching some information about database. So some modifications done after instance creation might fail to be noticed.- Overrides:
newCachedDatabase
in classObjectDatabase
- Returns:
- new cached database instance
-
newCachedFileObjectDatabase
CachedObjectDirectory newCachedFileObjectDatabase()
-
getAlternateId
ObjectDirectory.AlternateHandle.Id getAlternateId()
-
-