Modifier and Type	Class and Description
private static class	DirCache.DirCacheConfig
public static enum	DirCache.DirCacheVersion DirCache versions

Modifier and Type	Field and Description
pack-priv static final Comparator<DirCacheEntry>	ENT_CMP
private int	entryCnt Number of positions within `sortedEntries` that are valid.
private static final int	EXT_TREE
private IndexChangedListener	indexChangedListener listener to be informed on commit
private final File	liveFile Location of the current version of the index file.
private LockFile	myLock Our active lock (if we hold it); null if we don't have it locked.
private static final byte[]	NO_CHECKSUM
private static final DirCacheEntry[]	NO_ENTRIES
private byte[]	readIndexChecksum index checksum when index was read from disk
private Repository	repository Repository containing this index
private static final byte[]	SIG_DIRC
private boolean	skipHash Whether to skip computing and checking the index checksum
private FileSnapshot	snapshot Keep track of whether the index has changed or not
private DirCacheEntry[]	sortedEntries Individual file index entries, sorted by path name.
private DirCacheTree	tree Cache tree for this index; null if the cache tree is not available.
private DirCache.DirCacheVersion	version If we read this index from disk, the original format.
private byte[]	writeIndexChecksum index checksum when index was written to disk

Access	Constructor and Description
public	DirCache(File location of the index file on disk. indexLocation, FS the file system abstraction which will be necessary to perform certain file system operations. fs) Create a new in-core index representation.

Method Summary

Modifier and Type	Method and Description
public DirCacheBuilder	Returns: a new builder instance for this cache. builder() Create a new builder to update this cache.
public void	clear() Empty this index, removing all entries.
pack-priv static int	cmp(DirCacheEntry a, DirCacheEntry b)
pack-priv static int	cmp(byte[] aPath, int aLen, DirCacheEntry b)
pack-priv static int	cmp(final byte[] aPath, final int aLen, final byte[] bPath, final int bLen)
public boolean	Returns: true if the commit was successful and the file contains the new data; false if the commit failed and the file remains with the old data. commit() Commit this change and release the lock.
public DirCacheEditor	Returns: a new builder instance for this cache. editor() Create a new editor to recreate this cache.
public int	Returns: if >= 0 then the return value is the position of the entry in the index; pass to `getEntry(int)` to obtain the entry information. If < 0 the entry does not exist in the index. findEntry(String the path to search for. path) Locate the position a path's entry is at in the index.
public int	Returns: if >= 0 then the return value is the position of the entry in the index; pass to `getEntry(int)` to obtain the entry information. If < 0 the entry does not exist in the index. findEntry(byte[] the byte array starting with the path to search for. p, int the length of the path in bytes pLen) Locate the position a path's entry is at in the index.
pack-priv int	findEntry(int low, byte[] p, int pLen)
private static String	formatExtensionName(byte[] hdr)
public DirCacheTree	Returns: the cache tree; null if there is no current cache tree available and `build` was false. getCacheTree(boolean if true and the cache tree is not present in the index it will be generated and returned to the caller. build) Obtain (or build) the current cache tree structure.
public DirCacheEntry[]	Returns: all entries recursively contained within the subtree. getEntriesWithin(String the subtree path to get all entries within. path) Recursively get all entries within a subtree.
public DirCacheEntry	Returns: the entry at position `i`. getEntry(int position of the entry to get. i) Get a specific entry.
public DirCacheEntry	Returns: the entry for the given `path`. getEntry(String the path to search for. path) Get a specific entry.
public int	Returns: number of entries available. getEntryCount() Total number of file entries stored in the index.
pack-priv DirCache.DirCacheVersion	getVersion()
public boolean	Returns: `true` if this index contains unmerged paths. Means: at least one entry is of a stage different from 0. `false` will be returned if all entries are of stage 0. hasUnmergedPaths() Tells whether this index contains unmerged paths.
private static boolean	is_DIRC(byte[] hdr)
public boolean	Returns: `true` if the memory state differs from the index file isOutdated() Whether the memory state differs from the index file
public static DirCache	Returns: a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist. lock(File location of the index file on disk. indexLocation, FS the file system abstraction which will be necessary to perform certain file system operations. fs) Create a new in-core index representation, lock it, and read from disk.
public static DirCache	Returns: a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist. lock(final Repository repository containing the index to lock and read repository, final IndexChangedListener listener to be informed when DirCache is committed indexChangedListener) Create a new in-core index representation, lock it, and read from disk.
public static DirCache	Returns: a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist. lock(final File location of the index file on disk. indexLocation, final FS the file system abstraction which will be necessary to perform certain file system operations. fs, IndexChangedListener listener to be informed when DirCache is committed indexChangedListener) Create a new in-core index representation, lock it, and read from disk.
public boolean	Returns: true if the lock is now held by the caller; false if it is held by someone else. lock() Try to establish an update lock on the cache file.
public static DirCache	Returns: an empty cache which has no backing store file. The cache may not be read or written, but it may be queried and updated (in memory). newInCore() Create a new empty index which is never stored on disk.
private MessageDigest	newMessageDigest()
public int	Returns: position of the next entry whose path is after the input. nextEntry(int entry position of the path that should be skipped. position) Determine the next index position past all entries with the same name.
pack-priv int	nextEntry(byte[] p, int pLen, int nextIdx)
public static DirCache	Returns: a new cache which has no backing store file, but contains the contents of `treeId`. read(ObjectReader reader to access the tree objects from a repository. reader, AnyObjectId tree to read. Must identify a tree, not a tree-ish. treeId) Create a new in memory index read from the contents of a tree.
public static DirCache	Returns: a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist. read(Repository repository containing the index to read repository) Create a new in-core index representation and read an index from disk.
public static DirCache	Returns: a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist. read(File location of the index file on disk. indexLocation, FS the file system abstraction which will be necessary to perform certain file system operations. fs) Create a new in-core index representation and read an index from disk.
public void	read() Read the index from disk, if it has changed on disk.
private void	readConfig()
private void	readFrom(InputStream inStream)
private void	registerIndexChangedListener(IndexChangedListener listener)
pack-priv void	replace(DirCacheEntry[] e, int cnt)
private void	requireLocked(LockFile tmp)
private void	skipOptionalExtension(final InputStream in, final MessageDigest md, final byte[] hdr, long sz)
pack-priv void	toArray(final int i, final DirCacheEntry[] dst, final int off, final int cnt)
public void	unlock() Unlock this file and abort this change.
private void	updateSmudgedEntries() Update any smudged entries with information from the working tree.
public void	write() Write the entry records from memory to disk.
pack-priv void	writeTo(File dir, OutputStream os)
public ObjectId	Returns: identity for the root tree. writeTree(ObjectInserter the writer to use when serializing to the store. The caller is responsible for flushing the inserter before trying to use the returned tree identity. ow) Write all index trees to the object store, returning the root tree.

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

Field Detail

ENT_CMP	back to summary
pack-priv static final Comparator<DirCacheEntry> ENT_CMP

entryCnt	back to summary
private int entryCnt Number of positions within `sortedEntries` that are valid.

EXT_TREE	back to summary
private static final int EXT_TREE

indexChangedListener	back to summary
private IndexChangedListener indexChangedListener listener to be informed on commit

liveFile	back to summary
private final File liveFile Location of the current version of the index file.

myLock	back to summary
private LockFile myLock Our active lock (if we hold it); null if we don't have it locked.

NO_CHECKSUM	back to summary
private static final byte[] NO_CHECKSUM

NO_ENTRIES	back to summary
private static final DirCacheEntry[] NO_ENTRIES

readIndexChecksum	back to summary
private byte[] readIndexChecksum index checksum when index was read from disk

repository	back to summary
private Repository repository Repository containing this index

SIG_DIRC	back to summary
private static final byte[] SIG_DIRC

skipHash	back to summary
private boolean skipHash Whether to skip computing and checking the index checksum

snapshot	back to summary
private FileSnapshot snapshot Keep track of whether the index has changed or not

sortedEntries	back to summary
private DirCacheEntry[] sortedEntries Individual file index entries, sorted by path name.

tree	back to summary
private DirCacheTree tree Cache tree for this index; null if the cache tree is not available.

version	back to summary
private DirCache.DirCacheVersion version If we read this index from disk, the original format.

writeIndexChecksum	back to summary
private byte[] writeIndexChecksum index checksum when index was written to disk

Constructor Detail

DirCache back to summary

DirCache	back to summary
public DirCache(File indexLocation, FS fs) Create a new in-core index representation. The new index will be empty. Callers may wish to read from the on disk file first with `read()`. Parameters indexLocation:File location of the index file on disk. fs:FS the file system abstraction which will be necessary to perform certain file system operations.

public DirCache(File indexLocation, FS fs)

Create a new in-core index representation.

The new index will be empty. Callers may wish to read from the on disk file first with read().

Parameters

indexLocation:File: location of the index file on disk.
fs:FS: the file system abstraction which will be necessary to perform certain file system operations.

Method Detail

builder back to summary

builder	back to summary
public DirCacheBuilder builder() Create a new builder to update this cache. Callers should add all entries to the builder, then use `org.eclipse.jgit.dircache.DirCacheBuilder#finish()` to update this instance. Returns:DirCacheBuilder a new builder instance for this cache.

public DirCacheBuilder builder()

Create a new builder to update this cache.

Callers should add all entries to the builder, then use org.eclipse.jgit.dircache.DirCacheBuilder#finish() to update this instance.

Returns:DirCacheBuilder: a new builder instance for this cache.

clear	back to summary
public void clear() Empty this index, removing all entries.

cmp	back to summary
pack-priv static int cmp(DirCacheEntry a, DirCacheEntry b)

cmp	back to summary
pack-priv static int cmp(byte[] aPath, int aLen, DirCacheEntry b)

cmp	back to summary
pack-priv static int cmp(final byte[] aPath, final int aLen, final byte[] bPath, final int bLen)

commit	back to summary
public boolean commit() Commit this change and release the lock. If this method fails (returns false) the lock is still released. Returns:boolean true if the commit was successful and the file contains the new data; false if the commit failed and the file remains with the old data. Exceptions IllegalStateException: the lock is not held.

commit

back to summary

public boolean commit()

Commit this change and release the lock.

If this method fails (returns false) the lock is still released.

Returns:boolean

true if the commit was successful and the file contains the new data; false if the commit failed and the file remains with the old data.

Exceptions

IllegalStateException:: the lock is not held.

editor back to summary

editor	back to summary
public DirCacheEditor editor() Create a new editor to recreate this cache. Callers should add commands to the editor, then use `org.eclipse.jgit.dircache.DirCacheEditor#finish()` to update this instance. Returns:DirCacheEditor a new builder instance for this cache.

public DirCacheEditor editor()

Create a new editor to recreate this cache.

Callers should add commands to the editor, then use org.eclipse.jgit.dircache.DirCacheEditor#finish() to update this instance.

Returns:DirCacheEditor: a new builder instance for this cache.

findEntry back to summary

findEntry	back to summary
public int findEntry(String path) Locate the position a path's entry is at in the index. For details refer to #findEntry(byte[], int). Parameters path:String the path to search for. Returns:int if >= 0 then the return value is the position of the entry in the index; pass to `getEntry(int)` to obtain the entry information. If < 0 the entry does not exist in the index.

public int findEntry(String path)

Locate the position a path's entry is at in the index. For details refer to #findEntry(byte[], int).

Parameters

path:String: the path to search for.

Returns:int

if >= 0 then the return value is the position of the entry in the index; pass to getEntry(int) to obtain the entry information. If < 0 the entry does not exist in the index.

findEntry back to summary

findEntry	back to summary
public int findEntry(byte[] p, int pLen) Locate the position a path's entry is at in the index. If there is at least one entry in the index for this path the position of the lowest stage is returned. Subsequent stages can be identified by testing consecutive entries until the path differs. If no path matches the entry -(position+1) is returned, where position is the location it would have gone within the index. Parameters p:byte[] the byte array starting with the path to search for. pLen:int the length of the path in bytes Returns:int if >= 0 then the return value is the position of the entry in the index; pass to `getEntry(int)` to obtain the entry information. If < 0 the entry does not exist in the index. Since 3.4

public int findEntry(byte[] p, int pLen)

Locate the position a path's entry is at in the index.

If there is at least one entry in the index for this path the position of the lowest stage is returned. Subsequent stages can be identified by testing consecutive entries until the path differs.

If no path matches the entry -(position+1) is returned, where position is the location it would have gone within the index.

Parameters

p:byte[]: the byte array starting with the path to search for.
pLen:int: the length of the path in bytes

Returns:int

if >= 0 then the return value is the position of the entry in the index; pass to getEntry(int) to obtain the entry information. If < 0 the entry does not exist in the index.

Since

3.4

findEntry	back to summary
pack-priv int findEntry(int low, byte[] p, int pLen)

formatExtensionName	back to summary
private static String formatExtensionName(byte[] hdr)

getCacheTree back to summary

getCacheTree	back to summary
public DirCacheTree getCacheTree(boolean build) Obtain (or build) the current cache tree structure. This method can optionally recreate the cache tree, without flushing the tree objects themselves to disk. Parameters build:boolean if true and the cache tree is not present in the index it will be generated and returned to the caller. Returns:DirCacheTree the cache tree; null if there is no current cache tree available and `build` was false.

public DirCacheTree getCacheTree(boolean build)

Obtain (or build) the current cache tree structure.

This method can optionally recreate the cache tree, without flushing the tree objects themselves to disk.

Parameters

build:boolean: if true and the cache tree is not present in the index it will be generated and returned to the caller.

Returns:DirCacheTree

the cache tree; null if there is no current cache tree available and build was false.

getEntriesWithin	back to summary
public DirCacheEntry[] getEntriesWithin(String path) Recursively get all entries within a subtree. Parameters path:String the subtree path to get all entries within. Returns:DirCacheEntry[] all entries recursively contained within the subtree.

getEntriesWithin

back to summary

public DirCacheEntry[] getEntriesWithin(String path)

Recursively get all entries within a subtree.

Parameters

path:String: the subtree path to get all entries within.

Returns:DirCacheEntry[]

all entries recursively contained within the subtree.

getEntry back to summary

getEntry	back to summary
public DirCacheEntry getEntry(int i) Get a specific entry. Parameters i:int position of the entry to get. Returns:DirCacheEntry the entry at position `i`.

public DirCacheEntry getEntry(int i)

Get a specific entry.

Parameters

i:int: position of the entry to get.

Returns:DirCacheEntry

the entry at position i.

getEntry back to summary

getEntry	back to summary
public DirCacheEntry getEntry(String path) Get a specific entry. Parameters path:String the path to search for. Returns:DirCacheEntry the entry for the given `path`.

public DirCacheEntry getEntry(String path)

Get a specific entry.

Parameters

path:String: the path to search for.

Returns:DirCacheEntry

the entry for the given path.

getEntryCount back to summary

getEntryCount	back to summary
public int getEntryCount() Total number of file entries stored in the index. This count includes unmerged stages for a file entry if the file is currently conflicted in a merge. This means the total number of entries in the index may be up to 3 times larger than the number of files in the working directory. Note that this value counts only files. Returns:int number of entries available. See Also `getEntry(int)`

public int getEntryCount()

Total number of file entries stored in the index.

This count includes unmerged stages for a file entry if the file is currently conflicted in a merge. This means the total number of entries in the index may be up to 3 times larger than the number of files in the working directory.

Note that this value counts only files.

Returns:int: number of entries available.
See Also: getEntry(int)

getVersion	back to summary
pack-priv DirCache.DirCacheVersion getVersion()

hasUnmergedPaths back to summary

hasUnmergedPaths	back to summary
public boolean hasUnmergedPaths() Tells whether this index contains unmerged paths. Returns:boolean `true` if this index contains unmerged paths. Means: at least one entry is of a stage different from 0. `false` will be returned if all entries are of stage 0.

public boolean hasUnmergedPaths()

Tells whether this index contains unmerged paths.

Returns:boolean: true if this index contains unmerged paths. Means: at least one entry is of a stage different from 0. false will be returned if all entries are of stage 0.

is_DIRC	back to summary
private static boolean is_DIRC(byte[] hdr)

isOutdated back to summary

isOutdated	back to summary
public boolean isOutdated() throws IOException Whether the memory state differs from the index file Returns:boolean `true` if the memory state differs from the index file Exceptions IOException: if an IO error occurred

public boolean isOutdated() throws IOException

Whether the memory state differs from the index file

Returns:boolean

true if the memory state differs from the index file

Exceptions

IOException:: if an IO error occurred

lock	back to summary
public static DirCache lock(File indexLocation, FS fs) throws CorruptObjectException, IOException Create a new in-core index representation, lock it, and read from disk. The new index will be locked and then read before it is returned to the caller. Read failures are reported as exceptions and therefore prevent the method from returning a partially populated index. On read failure, the lock is released. Parameters indexLocation:File location of the index file on disk. fs:FS the file system abstraction which will be necessary to perform certain file system operations. Returns:DirCache a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist. Exceptions CorruptObjectException: the index file is using a format or extension that this library does not support. IOException: the index file is present but could not be read, or the lock could not be obtained.

lock

back to summary

public static DirCache lock(File indexLocation, FS fs) throws CorruptObjectException, IOException

Create a new in-core index representation, lock it, and read from disk.

The new index will be locked and then read before it is returned to the caller. Read failures are reported as exceptions and therefore prevent the method from returning a partially populated index. On read failure, the lock is released.

Parameters

indexLocation:File: location of the index file on disk.
fs:FS: the file system abstraction which will be necessary to perform certain file system operations.

Returns:DirCache

a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist.

Exceptions

CorruptObjectException:: the index file is using a format or extension that this library does not support.
IOException:: the index file is present but could not be read, or the lock could not be obtained.

lock	back to summary
public static DirCache lock(final Repository repository, final IndexChangedListener indexChangedListener) throws CorruptObjectException, IOException Create a new in-core index representation, lock it, and read from disk. The new index will be locked and then read before it is returned to the caller. Read failures are reported as exceptions and therefore prevent the method from returning a partially populated index. On read failure, the lock is released. Parameters repository:Repository repository containing the index to lock and read indexChangedListener:IndexChangedListener listener to be informed when DirCache is committed Returns:DirCache a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist. Exceptions CorruptObjectException: the index file is using a format or extension that this library does not support. IOException: the index file is present but could not be read, or the lock could not be obtained. Since 2.0

lock

back to summary

public static DirCache lock(final Repository repository, final IndexChangedListener indexChangedListener) throws CorruptObjectException, IOException

Create a new in-core index representation, lock it, and read from disk.

Parameters

repository:Repository: repository containing the index to lock and read
indexChangedListener:IndexChangedListener: listener to be informed when DirCache is committed

Returns:DirCache

a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist.

Exceptions

CorruptObjectException:: the index file is using a format or extension that this library does not support.
IOException:: the index file is present but could not be read, or the lock could not be obtained.

Since

2.0

lock	back to summary
public static DirCache lock(final File indexLocation, final FS fs, IndexChangedListener indexChangedListener) throws CorruptObjectException, IOException Create a new in-core index representation, lock it, and read from disk. The new index will be locked and then read before it is returned to the caller. Read failures are reported as exceptions and therefore prevent the method from returning a partially populated index. On read failure, the lock is released. Parameters indexLocation:File location of the index file on disk. fs:FS the file system abstraction which will be necessary to perform certain file system operations. indexChangedListener:IndexChangedListener listener to be informed when DirCache is committed Returns:DirCache a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist. Exceptions CorruptObjectException: the index file is using a format or extension that this library does not support. IOException: the index file is present but could not be read, or the lock could not be obtained.

lock

back to summary

public static DirCache lock(final File indexLocation, final FS fs, IndexChangedListener indexChangedListener) throws CorruptObjectException, IOException

Create a new in-core index representation, lock it, and read from disk.

Parameters

indexLocation:File: location of the index file on disk.
fs:FS: the file system abstraction which will be necessary to perform certain file system operations.
indexChangedListener:IndexChangedListener: listener to be informed when DirCache is committed

Returns:DirCache

a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist.

Exceptions

CorruptObjectException:: the index file is using a format or extension that this library does not support.
IOException:: the index file is present but could not be read, or the lock could not be obtained.

lock	back to summary
public boolean lock() throws IOException Try to establish an update lock on the cache file. Returns:boolean true if the lock is now held by the caller; false if it is held by someone else. Exceptions IOException: the output file could not be created. The caller does not hold the lock.

lock

back to summary

public boolean lock() throws IOException

Try to establish an update lock on the cache file.

Returns:boolean

true if the lock is now held by the caller; false if it is held by someone else.

Exceptions

IOException:: the output file could not be created. The caller does not hold the lock.

newInCore	back to summary
public static DirCache newInCore() Create a new empty index which is never stored on disk. Returns:DirCache an empty cache which has no backing store file. The cache may not be read or written, but it may be queried and updated (in memory).

newInCore

back to summary

public static DirCache newInCore()

Create a new empty index which is never stored on disk.

Returns:DirCache: an empty cache which has no backing store file. The cache may not be read or written, but it may be queried and updated (in memory).

newMessageDigest	back to summary
private MessageDigest newMessageDigest()

nextEntry	back to summary
public int nextEntry(int position) Determine the next index position past all entries with the same name. As index entries are sorted by path name, then stage number, this method advances the supplied position to the first position in the index whose path name does not match the path name of the supplied position's entry. Parameters position:int entry position of the path that should be skipped. Returns:int position of the next entry whose path is after the input.

back to summary

public int nextEntry(int position)

Determine the next index position past all entries with the same name.

As index entries are sorted by path name, then stage number, this method advances the supplied position to the first position in the index whose path name does not match the path name of the supplied position's entry.

Parameters

position:int: entry position of the path that should be skipped.

Returns:int

position of the next entry whose path is after the input.

nextEntry	back to summary
pack-priv int nextEntry(byte[] p, int pLen, int nextIdx)

read back to summary

public static DirCache read(ObjectReader reader, AnyObjectId treeId) throws IOException

Create a new in memory index read from the contents of a tree.

Parameters

reader:ObjectReader: reader to access the tree objects from a repository.
treeId:AnyObjectId: tree to read. Must identify a tree, not a tree-ish.

Returns:DirCache

a new cache which has no backing store file, but contains the contents of treeId.

Exceptions

IOException:: one or more trees not available from the ObjectReader.

Since

4.2

read

back to summary

public static DirCache read(Repository repository) throws CorruptObjectException, IOException

Create a new in-core index representation and read an index from disk.

The new index will be read before it is returned to the caller. Read failures are reported as exceptions and therefore prevent the method from returning a partially populated index.

Parameters

repository:Repository: repository containing the index to read

Returns:DirCache

a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist.

Exceptions

CorruptObjectException:: the index file is using a format or extension that this library does not support.
IOException:: the index file is present but could not be read.

read

back to summary

public static DirCache read(File indexLocation, FS fs) throws CorruptObjectException, IOException

Create a new in-core index representation and read an index from disk.

The new index will be read before it is returned to the caller. Read failures are reported as exceptions and therefore prevent the method from returning a partially populated index.

Parameters

indexLocation:File: location of the index file on disk.
fs:FS: the file system abstraction which will be necessary to perform certain file system operations.

Returns:DirCache

a cache representing the contents of the specified index file (if it exists) or an empty cache if the file does not exist.

Exceptions

CorruptObjectException:: the index file is using a format or extension that this library does not support.
IOException:: the index file is present but could not be read.

read

back to summary

public void read() throws IOException, CorruptObjectException

Read the index from disk, if it has changed on disk.

This method tries to avoid loading the index if it has not changed since the last time we consulted it. A missing index file will be treated as though it were present but had no file entries in it.

Exceptions

IOException:: the index file is present but could not be read. This DirCache instance may not be populated correctly.
CorruptObjectException:: the index file is using a format or extension that this library does not support.

readConfig	back to summary
private void readConfig()

readFrom	back to summary
private void readFrom(InputStream inStream) throws IOException, CorruptObjectException

registerIndexChangedListener	back to summary
private void registerIndexChangedListener(IndexChangedListener listener)

replace	back to summary
pack-priv void replace(DirCacheEntry[] e, int cnt)

requireLocked	back to summary
private void requireLocked(LockFile tmp)

skipOptionalExtension	back to summary
private void skipOptionalExtension(final InputStream in, final MessageDigest md, final byte[] hdr, long sz) throws IOException

toArray	back to summary
pack-priv void toArray(final int i, final DirCacheEntry[] dst, final int off, final int cnt)

unlock

back to summary

public void unlock()

Unlock this file and abort this change.

The temporary file (if created) is deleted before returning.

updateSmudgedEntries

back to summary

private void updateSmudgedEntries() throws IOException

Update any smudged entries with information from the working tree.

Exceptions

IOException:: if an IO error occurred

write back to summary

public void write() throws IOException

Write the entry records from memory to disk.

The cache must be locked first by calling lock() and receiving true as the return value. Applications are encouraged to lock the index, then invoke read() to ensure the in-memory data is current, prior to updating the in-memory entries.

Once written the lock is closed and must be either committed with commit() or rolled back with unlock().

Exceptions

IOException:: the output file could not be created. The caller no longer holds the lock.

writeTo	back to summary
pack-priv void writeTo(File dir, OutputStream os) throws IOException

writeTree

back to summary

public ObjectId writeTree(ObjectInserter ow) throws UnmergedPathException, IOException

Write all index trees to the object store, returning the root tree.

Parameters

ow:ObjectInserter: the writer to use when serializing to the store. The caller is responsible for flushing the inserter before trying to use the returned tree identity.

Returns:ObjectId

identity for the root tree.

Exceptions

UnmergedPathException:: one or more paths contain higher-order stages (stage > 0), which cannot be stored in a tree object.
IOException:: an unexpected error occurred writing to the object store.
IllegalStateException:: one or more paths contain an invalid mode which should never appear in a tree object.

org.eclipse.jgit.dircache back to summary

private Class DirCache.DirCacheConfig

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.dircache.DirCache.DirCacheConfig

Field Summary

Modifier and Type	Field and Description
private final DirCache.DirCacheVersion	indexVersion
private final boolean	skipHash

Constructor Summary

Access	Constructor and Description
public	DirCacheConfig(Config cfg)

Method Summary

Modifier and Type	Method and Description
public DirCache.DirCacheVersion	getIndexVersion()
public boolean	isSkipHash()

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

Field Detail

indexVersion	back to summary
private final DirCache.DirCacheVersion indexVersion

skipHash	back to summary
private final boolean skipHash

Constructor Detail

DirCacheConfig	back to summary
public DirCacheConfig(Config cfg)

Method Detail

getIndexVersion	back to summary
public DirCache.DirCacheVersion getIndexVersion()

isSkipHash	back to summary
public boolean isSkipHash()

org.eclipse.jgit.dircache back to summary

public final Enum DirCache.DirCacheVersion

Class Inheritance

extends Enum<DirCache.DirCacheVersion>
implements ConfigEnum

java.lang.Object
java.lang.Enum
org.eclipse.jgit.dircache.DirCache.DirCacheVersion

All Implemented Interfaces

org.eclipse.jgit.lib.Config.ConfigEnum

DirCache versions

Since: 7.2

Field Summary

Modifier and Type	Field and Description
public static final DirCache.DirCacheVersion	DIRC_VERSION_EXTENDED Version 3 supports extended flags.
public static final DirCache.DirCacheVersion	DIRC_VERSION_MINIMUM Minimum index version on-disk format that we support.
public static final DirCache.DirCacheVersion	DIRC_VERSION_PATHCOMPRESS Version 4 adds very simple "path compression": it strips out the common prefix between the last entry written and the current entry.
private final int	version

Constructor Summary

Access	Constructor and Description
private	DirCacheVersion(int versionCode)

Method Summary

Modifier and Type	Method and Description
public static DirCache.DirCacheVersion	Returns: the DirCacheVersion instance of the version code. fromInt(int integer value of the version code. val) Create DirCacheVersion from integer value of the version code.
public int	Returns: the version code for this version getVersionCode()
public boolean	matchConfigValue(String the string to match in) Implements org.eclipse.jgit.lib.Config.ConfigEnum.matchConfigValue. Checks if the given string matches with enum value.
public String	toConfigValue() Implements org.eclipse.jgit.lib.Config.ConfigEnum.toConfigValue. Converts enumeration value into a string to be save in config.
public static DirCache.DirCacheVersion	valueOf(String name)
public static DirCache.DirCacheVersion[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DIRC_VERSION_EXTENDED	back to summary
public static final DirCache.DirCacheVersion DIRC_VERSION_EXTENDED Version 3 supports extended flags.

DIRC_VERSION_MINIMUM	back to summary
public static final DirCache.DirCacheVersion DIRC_VERSION_MINIMUM Minimum index version on-disk format that we support.

DIRC_VERSION_PATHCOMPRESS

back to summary

public static final DirCache.DirCacheVersion DIRC_VERSION_PATHCOMPRESS

Version 4 adds very simple "path compression": it strips out the common prefix between the last entry written and the current entry. Instead of writing two entries with paths "foo/bar/baz/a.txt" and "foo/bar/baz/b.txt" it only writes "b.txt" for the second entry.

It is also not padded.