org.eclipse.jgit.lib

Class FileModeCache

java.lang.Object

org.eclipse.jgit.lib.FileModeCache

public class FileModeCache
extends Object

A hierarchical cache of FileModes per git path.

Since:

5.13.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileModeCache.CacheItem An item from a FileModeCache, recording information about a git path (known from context).

Constructor Summary

Constructors

Constructor and Description
FileModeCache(Repository repo) Creates a new FileModeCache for a Repository.

Method Summary

Modifier and Type	Method and Description
Repository	getRepository() Retrieves the Repository.
FileModeCache.CacheItem	getRoot() Obtains the FileModeCache.CacheItem for the working tree root.
FileModeCache.CacheItem	safeCreateDirectory(String gitPath, File dir, boolean makeSpace) Ensures the given directory dir with the given git path exists.
void	safeCreateParentDirectory(String gitPath, File parentDir, boolean makeSpace) Ensure that the given parent directory exists, and cache the information that gitPath refers to a file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileModeCache

public FileModeCache(@NonNull
                     Repository repo)

Creates a new FileModeCache for a Repository.

Parameters:

repo - Repository this cache is for

Method Detail

getRepository

@NonNull
public Repository getRepository()

Retrieves the Repository.

Returns:

the Repository this FileModeCache was created for

getRoot

@NonNull
public FileModeCache.CacheItem getRoot()

Obtains the FileModeCache.CacheItem for the working tree root.

Returns:

the FileModeCache.CacheItem

safeCreateParentDirectory

public void safeCreateParentDirectory(String gitPath,
                                      File parentDir,
                                      boolean makeSpace)
                               throws IOException

Ensure that the given parent directory exists, and cache the information that gitPath refers to a file.

Parameters:

gitPath - of the file to be written

parentDir - directory in which the file shall be placed, assumed to be the parent of the gitPath

makeSpace - whether to delete a possibly existing file at parentDir

Throws:

IOException - if the directory cannot be created, if necessary

safeCreateDirectory

public FileModeCache.CacheItem safeCreateDirectory(String gitPath,
                                                   File dir,
                                                   boolean makeSpace)
                                            throws IOException

Ensures the given directory dir with the given git path exists.

Parameters:

gitPath - of a file to be written

dir - directory in which the file shall be placed, assumed to be the parent of the gitPath

makeSpace - whether to remove a file that already at that name

Returns:

A FileModeCache.CacheItem describing the directory, which is guaranteed to exist

Throws:

IOException - if the directory cannot be made to exist at the given location