Modifier and Type	Class and Description
public static class	RepositoryCache.FileKey Location of a Repository, using the standard java.io.File API.
public static interface	RepositoryCache.Key Abstract hash key for `RepositoryCache` entries.
private static class	RepositoryCache.Lock

Modifier and Type	Field and Description
private static final RepositoryCache	cache
private final Map<RepositoryCache.Key, Repository>	cacheMap
private ScheduledFuture<?>	cleanupTask
private volatile long	expireAfter
private static final Logger	LOG
private final RepositoryCache.Lock[]	openLocks
private final Object	schedulerLock

Access	Constructor and Description
private	RepositoryCache()

Method Summary

Modifier and Type	Method and Description
public static void	clear() Unregister all repositories from the cache.
private void	clearAll()
private void	clearAllExpired()
pack-priv static void	clearExpired()
public static void	close(Repository repository to unregister. db) Close and remove a repository from the cache.
private void	configureEviction(RepositoryCacheConfig repositoryCacheConfig)
private Collection<RepositoryCache.Key>	getKeys()
public static Collection<RepositoryCache.Key>	Returns: the locations of all repositories registered in the cache. getRegisteredKeys() Get the locations of all repositories registered in the cache.
pack-priv static boolean	isCached(Repository repo)
private boolean	isExpired(Repository db)
private RepositoryCache.Lock	lockFor(RepositoryCache.Key location)
public static Repository	Returns: the repository instance requested; caller must close when done. open(RepositoryCache.Key where the local repository is. Typically a `org.eclipse.jgit.lib.RepositoryCache.FileKey`. location) Open an existing repository, reusing a cached instance if possible.
public static Repository	Returns: the repository instance requested; caller must close when done. open(RepositoryCache.Key where the local repository is. Typically a `org.eclipse.jgit.lib.RepositoryCache.FileKey`. location, boolean If true, and the repository is not found, throws `RepositoryNotFoundException`. If false, a repository instance is created and registered anyway. mustExist) Open a repository, reusing a cached instance if possible.
private Repository	openRepository(final RepositoryCache.Key location, final boolean mustExist)
pack-priv static void	reconfigure(RepositoryCacheConfig repositoryCacheConfig)
public static void	register(Repository repository to register. db) Register one repository into the cache.
private void	registerRepository(RepositoryCache.Key location, Repository db)
public static void	unregister(Repository repository to unregister. db) Remove a repository from the cache.
public static void	unregister(RepositoryCache.Key location of the repository to remove. location) Remove a repository from the cache.
private void	unregisterAndCloseRepository(RepositoryCache.Key location)
private Repository	unregisterRepository(RepositoryCache.Key location)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

cache	back to summary
private static final RepositoryCache cache

cacheMap	back to summary
private final Map<RepositoryCache.Key, Repository> cacheMap

cleanupTask	back to summary
private ScheduledFuture<?> cleanupTask

expireAfter	back to summary
private volatile long expireAfter

LOG	back to summary
private static final Logger LOG

openLocks	back to summary
private final RepositoryCache.Lock[] openLocks

schedulerLock	back to summary
private final Object schedulerLock

RepositoryCache	back to summary
private RepositoryCache()

Method Detail

clear	back to summary
public static void clear() Unregister all repositories from the cache.

clearAll	back to summary
private void clearAll()

clearAllExpired	back to summary
private void clearAllExpired()

clearExpired	back to summary
pack-priv static void clearExpired()

close	back to summary
public static void close(Repository db) Close and remove a repository from the cache. Removes a repository from the cache, if it is still registered here, and close it. Parameters db:Repository repository to unregister.

back to summary

public static void close(Repository db)

Close and remove a repository from the cache.

Removes a repository from the cache, if it is still registered here, and close it.

Parameters

db:Repository: repository to unregister.

configureEviction	back to summary
private void configureEviction(RepositoryCacheConfig repositoryCacheConfig)

getKeys	back to summary
private Collection<RepositoryCache.Key> getKeys()

getRegisteredKeys	back to summary
public static Collection<RepositoryCache.Key> getRegisteredKeys() Get the locations of all repositories registered in the cache. Returns:Collection<RepositoryCache.Key> the locations of all repositories registered in the cache. Since 4.1

getRegisteredKeys

back to summary

public static Collection<RepositoryCache.Key> getRegisteredKeys()

Get the locations of all repositories registered in the cache.

Returns:Collection<RepositoryCache.Key>: the locations of all repositories registered in the cache.
Since: 4.1

isCached	back to summary
pack-priv static boolean isCached(Repository repo)

isExpired	back to summary
private boolean isExpired(Repository db)

lockFor	back to summary
private RepositoryCache.Lock lockFor(RepositoryCache.Key location)

open back to summary

open	back to summary
public static Repository open(RepositoryCache.Key location) throws IOException, RepositoryNotFoundException Open an existing repository, reusing a cached instance if possible. When done with the repository, the caller must call `org.eclipse.jgit.lib.Repository#close()` to decrement the repository's usage counter. Parameters location:RepositoryCache.Key where the local repository is. Typically a `org.eclipse.jgit.lib.RepositoryCache.FileKey`. Returns:Repository the repository instance requested; caller must close when done. Exceptions IOException: the repository could not be read (likely its core.version property is not supported). RepositoryNotFoundException: there is no repository at the given location.

public static Repository open(RepositoryCache.Key location) throws IOException, RepositoryNotFoundException

Open an existing repository, reusing a cached instance if possible.

When done with the repository, the caller must call org.eclipse.jgit.lib.Repository#close() to decrement the repository's usage counter.

Parameters

location:RepositoryCache.Key: where the local repository is. Typically a org.eclipse.jgit.lib.RepositoryCache.FileKey.

Returns:Repository

the repository instance requested; caller must close when done.

Exceptions

IOException:: the repository could not be read (likely its core.version property is not supported).
RepositoryNotFoundException:: there is no repository at the given location.

open back to summary

open	back to summary
public static Repository open(RepositoryCache.Key location, boolean mustExist) throws IOException Open a repository, reusing a cached instance if possible. When done with the repository, the caller must call `org.eclipse.jgit.lib.Repository#close()` to decrement the repository's usage counter. Parameters location:RepositoryCache.Key where the local repository is. Typically a `org.eclipse.jgit.lib.RepositoryCache.FileKey`. mustExist:boolean If true, and the repository is not found, throws `RepositoryNotFoundException`. If false, a repository instance is created and registered anyway. Returns:Repository the repository instance requested; caller must close when done. Exceptions IOException: the repository could not be read (likely its core.version property is not supported). RepositoryNotFoundException: There is no repository at the given location, only thrown if `mustExist` is true.

public static Repository open(RepositoryCache.Key location, boolean mustExist) throws IOException

Open a repository, reusing a cached instance if possible.

When done with the repository, the caller must call org.eclipse.jgit.lib.Repository#close() to decrement the repository's usage counter.

Parameters

location:RepositoryCache.Key: where the local repository is. Typically a org.eclipse.jgit.lib.RepositoryCache.FileKey.
mustExist:boolean: If true, and the repository is not found, throws RepositoryNotFoundException. If false, a repository instance is created and registered anyway.

Returns:Repository

the repository instance requested; caller must close when done.

Exceptions

IOException:: the repository could not be read (likely its core.version property is not supported).
RepositoryNotFoundException:: There is no repository at the given location, only thrown if mustExist is true.

openRepository	back to summary
private Repository openRepository(final RepositoryCache.Key location, final boolean mustExist) throws IOException

reconfigure	back to summary
pack-priv static void reconfigure(RepositoryCacheConfig repositoryCacheConfig)

register	back to summary
public static void register(Repository db) Register one repository into the cache. During registration the cache automatically increments the usage counter, permitting it to retain the reference. A `org.eclipse.jgit.lib.RepositoryCache.FileKey` for the repository's `org.eclipse.jgit.lib.Repository#getDirectory()` is used to index the repository in the cache. If another repository already is registered in the cache at this location, the other instance is closed. Parameters db:Repository repository to register.

public static void register(Repository db)

During registration the cache automatically increments the usage counter, permitting it to retain the reference. A org.eclipse.jgit.lib.RepositoryCache.FileKey for the repository's org.eclipse.jgit.lib.Repository#getDirectory() is used to index the repository in the cache.

If another repository already is registered in the cache at this location, the other instance is closed.

Parameters

db:Repository: repository to register.

registerRepository	back to summary
private void registerRepository(RepositoryCache.Key location, Repository db)

unregister back to summary

unregister	back to summary
public static void unregister(Repository db) Remove a repository from the cache. Removes a repository from the cache, if it is still registered here. This method will not close the repository, only remove it from the cache. See `org.eclipse.jgit.lib.RepositoryCache#close(Repository)` to remove and close the repository. Parameters db:Repository repository to unregister. Since 4.3

public static void unregister(Repository db)

Remove a repository from the cache.

Removes a repository from the cache, if it is still registered here. This method will not close the repository, only remove it from the cache. See org.eclipse.jgit.lib.RepositoryCache#close(Repository) to remove and close the repository.

Parameters

db:Repository: repository to unregister.

Since

4.3

unregister back to summary

unregister	back to summary
public static void unregister(RepositoryCache.Key location) Remove a repository from the cache. Removes a repository from the cache, if it is still registered here. This method will not close the repository, only remove it from the cache. See `org.eclipse.jgit.lib.RepositoryCache#close(Repository)` to remove and close the repository. Parameters location:RepositoryCache.Key location of the repository to remove. Since 4.1

public static void unregister(RepositoryCache.Key location)

Remove a repository from the cache.

Parameters

location:RepositoryCache.Key: location of the repository to remove.

Since

4.1

unregisterAndCloseRepository	back to summary
private void unregisterAndCloseRepository(RepositoryCache.Key location)

unregisterRepository	back to summary
private Repository unregisterRepository(RepositoryCache.Key location)

org.eclipse.jgit.lib back to summary

public Class RepositoryCache.FileKey

Class Inheritance

extends Object
implements Key

java.lang.Object
org.eclipse.jgit.lib.RepositoryCache.FileKey

All Implemented Interfaces

org.eclipse.jgit.lib.RepositoryCache.Key

Location of a Repository, using the standard java.io.File API.

Field Summary

Modifier and Type	Field and Description
private final FS	fs
private final File	path

Constructor Summary

Access	Constructor and Description
protected	FileKey(File exact location of the repository. directory, FS the file system abstraction which will be necessary to perform certain file system operations. fs) Create a pointer to a location on disk.

Method Summary

Modifier and Type	Method and Description
private static File	canonical(File path)
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static RepositoryCache.FileKey	Returns: a key for the given directory. exact(File location where the repository database is. directory, FS the file system abstraction which will be necessary to perform certain file system operations. fs) Obtain a pointer to an exact location on disk.
public final File	Returns: directory containing the repository database. getFile() Get directory containing the repository database
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static boolean	Returns: true if the directory "looks like" a Git repository; false if it doesn't look enough like a Git directory to really be a Git directory. isGitRepository(File the location of the directory to examine. dir, FS the file system abstraction which will be necessary to perform certain file system operations. fs) Guess if a directory contains a Git repository.
private static boolean	isValidHead(File head)
public static RepositoryCache.FileKey	Returns: a key for the given directory. lenient(File location where the repository database might be. directory, FS the file system abstraction which will be necessary to perform certain file system operations. fs) Obtain a pointer to a location on disk.
public Repository	open(boolean true if the repository must exist in order to be opened; false if a new non-existent repository is permitted to be created (the caller is responsible for calling create). mustExist) Implements org.eclipse.jgit.lib.RepositoryCache.Key.open. Called by `RepositoryCache#open(Key)` if it doesn't exist yet.
private static String	readFirstLine(File head)
public static File	Returns: the actual directory location if a better match is found; null if there is no suitable match. resolve(File location to guess from. Several permutations are tried. directory, FS the file system abstraction which will be necessary to perform certain file system operations. fs) Guess the proper path for a Git repository.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

fs	back to summary
private final FS fs

path	back to summary
private final File path

Constructor Detail

FileKey	back to summary
protected FileKey(File directory, FS fs) Create a pointer to a location on disk. Parameters directory:File exact location of the repository. fs:FS the file system abstraction which will be necessary to perform certain file system operations.

FileKey

back to summary

protected FileKey(File directory, FS fs)

Create a pointer to a location on disk.

Parameters

directory:File: exact location of the repository.
fs:FS: the file system abstraction which will be necessary to perform certain file system operations.

Method Detail

canonical	back to summary
private static File canonical(File path)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

exact back to summary

exact	back to summary
public static RepositoryCache.FileKey exact(File directory, FS fs) Obtain a pointer to an exact location on disk. No guessing is performed, the given location is exactly the GIT_DIR directory of the repository. Parameters directory:File location where the repository database is. fs:FS the file system abstraction which will be necessary to perform certain file system operations. Returns:RepositoryCache.FileKey a key for the given directory. See Also `lenient(File, FS)`

public static RepositoryCache.FileKey exact(File directory, FS fs)

Obtain a pointer to an exact location on disk.

No guessing is performed, the given location is exactly the GIT_DIR directory of the repository.

Parameters

directory:File: location where the repository database is.
fs:FS: the file system abstraction which will be necessary to perform certain file system operations.

Returns:RepositoryCache.FileKey

a key for the given directory.

See Also

lenient(File, FS)

getFile	back to summary
public final File getFile() Get directory containing the repository database Returns:File directory containing the repository database.

getFile

back to summary

public final File getFile()

Get directory containing the repository database

Returns:File: directory containing the repository database.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isGitRepository	back to summary
public static boolean isGitRepository(File dir, FS fs) Guess if a directory contains a Git repository. This method guesses by looking for the existence of some key files and directories. Parameters dir:File the location of the directory to examine. fs:FS the file system abstraction which will be necessary to perform certain file system operations. Returns:boolean true if the directory "looks like" a Git repository; false if it doesn't look enough like a Git directory to really be a Git directory.

isGitRepository

back to summary

public static boolean isGitRepository(File dir, FS fs)

Guess if a directory contains a Git repository.

This method guesses by looking for the existence of some key files and directories.

Parameters

dir:File: the location of the directory to examine.
fs:FS: the file system abstraction which will be necessary to perform certain file system operations.

Returns:boolean

true if the directory "looks like" a Git repository; false if it doesn't look enough like a Git directory to really be a Git directory.

isValidHead	back to summary
private static boolean isValidHead(File head)

lenient back to summary

lenient	back to summary
public static RepositoryCache.FileKey lenient(File directory, FS fs) Obtain a pointer to a location on disk. The method performs some basic guessing to locate the repository. Searched paths are: `directory` // assume exact match `directory` + "/.git" // assume working directory `directory` + ".git" // assume bare Parameters directory:File location where the repository database might be. fs:FS the file system abstraction which will be necessary to perform certain file system operations. Returns:RepositoryCache.FileKey a key for the given directory. See Also `exact(File, FS)`

public static RepositoryCache.FileKey lenient(File directory, FS fs)

Obtain a pointer to a location on disk.

The method performs some basic guessing to locate the repository. Searched paths are:

directory // assume exact match
directory + "/.git" // assume working directory
directory + ".git" // assume bare

Parameters

directory:File: location where the repository database might be.
fs:FS: the file system abstraction which will be necessary to perform certain file system operations.

Returns:RepositoryCache.FileKey

a key for the given directory.

See Also

exact(File, FS)

open back to summary

open	back to summary
public Repository open(boolean mustExist) throws IOException Implements org.eclipse.jgit.lib.RepositoryCache.Key.open. Doc from org.eclipse.jgit.lib.RepositoryCache.Key.open. Called by `RepositoryCache#open(Key)` if it doesn't exist yet. If a repository does not exist yet in the cache, the cache will call this method to acquire a handle to it. Parameters mustExist:boolean true if the repository must exist in order to be opened; false if a new non-existent repository is permitted to be created (the caller is responsible for calling create). Returns:Repository the new repository instance. Annotations @Override Exceptions IOException: the repository could not be read (likely its core.version property is not supported).

public Repository open(boolean mustExist) throws IOException

Implements org.eclipse.jgit.lib.RepositoryCache.Key.open.

Doc from org.eclipse.jgit.lib.RepositoryCache.Key.open.

Called by RepositoryCache#open(Key) if it doesn't exist yet.

If a repository does not exist yet in the cache, the cache will call this method to acquire a handle to it.

Parameters

mustExist:boolean: true if the repository must exist in order to be opened; false if a new non-existent repository is permitted to be created (the caller is responsible for calling create).

Returns:Repository

the new repository instance.

Annotations

@Override

Exceptions

IOException:: the repository could not be read (likely its core.version property is not supported).

readFirstLine	back to summary
private static String readFirstLine(File head)

resolve back to summary

resolve	back to summary
public static File resolve(File directory, FS fs) Guess the proper path for a Git repository. The method performs some basic guessing to locate the repository. Searched paths are: `directory` // assume exact match `directory` + "/.git" // assume working directory `directory` + ".git" // assume bare Parameters directory:File location to guess from. Several permutations are tried. fs:FS the file system abstraction which will be necessary to perform certain file system operations. Returns:File the actual directory location if a better match is found; null if there is no suitable match.

public static File resolve(File directory, FS fs)

Guess the proper path for a Git repository.

The method performs some basic guessing to locate the repository. Searched paths are:

directory // assume exact match
directory + "/.git" // assume working directory
directory + ".git" // assume bare

Parameters

directory:File: location to guess from. Several permutations are tried.
fs:FS: the file system abstraction which will be necessary to perform certain file system operations.

Returns:File

the actual directory location if a better match is found; null if there is no suitable match.

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class RepositoryCache

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class RepositoryCache.FileKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface RepositoryCache.Key

Method Summary

Method Detail

private Class RepositoryCache.Lock

Constructor Summary

Method Summary

Constructor Detail