org.eclipse.jgit.dircache

Class DirCacheCheckout

java.lang.Object

org.eclipse.jgit.dircache.DirCacheCheckout

public class DirCacheCheckout
extends Object

This class handles checking out one or two trees merging with the index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirCacheCheckout.CheckoutMetadata Metadata used in checkout process

Constructor Summary

Constructors

Constructor and Description
DirCacheCheckout(Repository repo, DirCache dc, ObjectId mergeCommitTree) Constructs a DirCacheCeckout for checking out one tree, merging with the index.
DirCacheCheckout(Repository repo, DirCache dc, ObjectId mergeCommitTree, WorkingTreeIterator workingTree) Constructs a DirCacheCeckout for checking out one tree, merging with the index.
DirCacheCheckout(Repository repo, ObjectId headCommitTree, DirCache dc, ObjectId mergeCommitTree) Constructs a DirCacheCeckout for merging and checking out two trees (HEAD and mergeCommitTree) and the index.
DirCacheCheckout(Repository repo, ObjectId headCommitTree, DirCache dc, ObjectId mergeCommitTree, WorkingTreeIterator workingTree) Constructs a DirCacheCeckout for merging and checking out two trees (HEAD and mergeCommitTree) and the index.

Method Summary

Modifier and Type	Method and Description
boolean	checkout() Execute this checkout.
static void	checkoutEntry(Repository repo, DirCacheEntry entry, ObjectReader or) Updates the file in the working tree with content and mode from an entry in the index.
static void	checkoutEntry(Repository repo, DirCacheEntry entry, ObjectReader or, boolean deleteRecursive, DirCacheCheckout.CheckoutMetadata checkoutMetadata) Updates the file in the working tree with content and mode from an entry in the index.
List<String>	getConflicts()
List<String>	getRemoved()
List<String>	getToBeDeleted()
Map<String,DirCacheCheckout.CheckoutMetadata>	getUpdated()
void	prescanOneTree() Scan index and merge tree (no HEAD).
void	preScanTwoTrees() Scan head, index and merge tree.
void	setFailOnConflict(boolean failOnConflict) If true, will scan first to see if it's possible to check out, otherwise throw CheckoutConflictException.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirCacheCheckout

public DirCacheCheckout(Repository repo,
                        ObjectId headCommitTree,
                        DirCache dc,
                        ObjectId mergeCommitTree,
                        WorkingTreeIterator workingTree)
                 throws IOException

Constructs a DirCacheCeckout for merging and checking out two trees (HEAD and mergeCommitTree) and the index.

Parameters:

repo - the repository in which we do the checkout

headCommitTree - the id of the tree of the head commit

dc - the (already locked) Dircache for this repo

mergeCommitTree - the id of the tree we want to fast-forward to

workingTree - an iterator over the repositories Working Tree

Throws:

IOException

DirCacheCheckout

public DirCacheCheckout(Repository repo,
                        ObjectId headCommitTree,
                        DirCache dc,
                        ObjectId mergeCommitTree)
                 throws IOException

Constructs a DirCacheCeckout for merging and checking out two trees (HEAD and mergeCommitTree) and the index. As iterator over the working tree this constructor creates a standard FileTreeIterator

Parameters:

repo - the repository in which we do the checkout

headCommitTree - the id of the tree of the head commit

dc - the (already locked) Dircache for this repo

mergeCommitTree - the id of the tree we want to fast-forward to

Throws:

IOException

DirCacheCheckout

public DirCacheCheckout(Repository repo,
                        DirCache dc,
                        ObjectId mergeCommitTree,
                        WorkingTreeIterator workingTree)
                 throws IOException

Constructs a DirCacheCeckout for checking out one tree, merging with the index.

Parameters:

repo - the repository in which we do the checkout

dc - the (already locked) Dircache for this repo

mergeCommitTree - the id of the tree we want to fast-forward to

workingTree - an iterator over the repositories Working Tree

Throws:

IOException

DirCacheCheckout

public DirCacheCheckout(Repository repo,
                        DirCache dc,
                        ObjectId mergeCommitTree)
                 throws IOException

Constructs a DirCacheCeckout for checking out one tree, merging with the index. As iterator over the working tree this constructor creates a standard FileTreeIterator

Parameters:

repo - the repository in which we do the checkout

dc - the (already locked) Dircache for this repo

mergeCommitTree - the id of the tree of the

Throws:

IOException

Method Detail

getUpdated

public Map<String,DirCacheCheckout.CheckoutMetadata> getUpdated()

Returns:

a list of updated paths and smudgeFilterCommands

getConflicts

public List<String> getConflicts()

Returns:

a list of conflicts created by this checkout

getToBeDeleted

public List<String> getToBeDeleted()

Returns:

a list of paths (relative to the start of the working tree) of files which couldn't be deleted during last call to checkout() . checkout() detected that these files should be deleted but the deletion in the filesystem failed (e.g. because a file was locked). To have a consistent state of the working tree these files have to be deleted by the callers of DirCacheCheckout.

getRemoved

public List<String> getRemoved()

Returns:

a list of all files removed by this checkout

preScanTwoTrees

public void preScanTwoTrees()
                     throws CorruptObjectException,
                            IOException

Scan head, index and merge tree. Used during normal checkout or merge operations.

Throws:

CorruptObjectException

IOException

prescanOneTree

public void prescanOneTree()
                    throws MissingObjectException,
                           IncorrectObjectTypeException,
                           CorruptObjectException,
                           IOException

Scan index and merge tree (no HEAD). Used e.g. for initial checkout when there is no head yet.

Throws:

MissingObjectException

IncorrectObjectTypeException

CorruptObjectException

IOException

checkout

public boolean checkout()
                 throws IOException

Execute this checkout. A WorkingTreeModifiedEvent is fired if the working tree was modified; even if the checkout fails.

Returns:

false if this method could not delete all the files which should be deleted (e.g. because one of the files was locked). In this case getToBeDeleted() lists the files which should be tried to be deleted outside of this method. Although false is returned the checkout was successful and the working tree was updated for all other files. true is returned when no such problem occurred

Throws:

IOException

setFailOnConflict

public void setFailOnConflict(boolean failOnConflict)

If true, will scan first to see if it's possible to check out, otherwise throw CheckoutConflictException. If false, it will silently deal with the problem.

Parameters:

failOnConflict -

checkoutEntry

public static void checkoutEntry(Repository repo,
                                 DirCacheEntry entry,
                                 ObjectReader or)
                          throws IOException

Updates the file in the working tree with content and mode from an entry in the index. The new content is first written to a new temporary file in the same directory as the real file. Then that new file is renamed to the final filename.

Note: if the entry path on local file system exists as a non-empty directory, and the target entry type is a link or file, the checkout will fail with IOException since existing non-empty directory cannot be renamed to file or link without deleting it recursively.

TODO: this method works directly on File IO, we may need another abstraction (like WorkingTreeIterator). This way we could tell e.g. Eclipse that Files in the workspace got changed

Parameters:

repo - repository managing the destination work tree.

entry - the entry containing new mode and content

or - object reader to use for checkout

Throws:

IOException

Since:

3.6

checkoutEntry

public static void checkoutEntry(Repository repo,
                                 DirCacheEntry entry,
                                 ObjectReader or,
                                 boolean deleteRecursive,
                                 DirCacheCheckout.CheckoutMetadata checkoutMetadata)
                          throws IOException

Updates the file in the working tree with content and mode from an entry in the index. The new content is first written to a new temporary file in the same directory as the real file. Then that new file is renamed to the final filename.

Note: if the entry path on local file system exists as a file, it will be deleted and if it exists as a directory, it will be deleted recursively, independently if has any content.

TODO: this method works directly on File IO, we may need another abstraction (like WorkingTreeIterator). This way we could tell e.g. Eclipse that Files in the workspace got changed

Parameters:

repo - repository managing the destination work tree.

entry - the entry containing new mode and content

or - object reader to use for checkout

deleteRecursive - true to recursively delete final path if it exists on the file system

checkoutMetadata - containing

• smudgeFilterCommand to be run for smudging the entry to be checked out
• eolStreamType used for stream conversion

Throws:

IOException

Since:

4.2