Class CheckoutCommand
- java.lang.Object
-
- org.eclipse.jgit.api.GitCommand<Ref>
-
- org.eclipse.jgit.api.CheckoutCommand
-
public class CheckoutCommand extends GitCommand<Ref>
Checkout a branch to the working tree.Examples (
git
is aGit
instance):Check out an existing branch:
git.checkout().setName("feature").call();
Check out paths from the index:
git.checkout().addPath("file1.txt").addPath("file2.txt").call();
Check out a path from a commit:
git.checkout().setStartPoint("HEADˆ").addPath("file1.txt").call();
Create a new branch and check it out:
git.checkout().setCreateBranch(true).setName("newbranch").call();
Create a new tracking branch for a remote branch and check it out:
git.checkout().setCreateBranch(true).setName("stable") .setUpstreamMode(SetupUpstreamMode.SET_UPSTREAM) .setStartPoint("origin/stable").call();
- See Also:
- Git documentation about Checkout
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CheckoutCommand.Stage
Stage to check out, seesetStage(Stage)
.
-
Field Summary
-
Fields inherited from class org.eclipse.jgit.api.GitCommand
repo
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CheckoutCommand(Repository repo)
Constructor for CheckoutCommand
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CheckoutCommand
addPath(String path)
Add a single slash-separated path to the list of paths to check out.CheckoutCommand
addPaths(List<String> p)
Add multiple slash-separated paths to the list of paths to check out.Ref
call()
protected CheckoutCommand
checkoutPaths()
Checkout paths into index and working directory, firing aWorkingTreeModifiedEvent
if the working tree was modified.CheckoutResult
getResult()
Get the result, nevernull
CheckoutCommand
setAllPaths(boolean all)
Set whether to checkout all paths.CheckoutCommand
setCreateBranch(boolean createBranch)
Specify whether to create a new branch.CheckoutCommand
setForce(boolean force)
Deprecated.this method was badly named comparing its semantics to native git's checkout --force option, usesetForceRefUpdate(boolean)
insteadCheckoutCommand
setForced(boolean forced)
Allow a checkout even if the workingtree or index differs from HEAD.CheckoutCommand
setForceRefUpdate(boolean forceRefUpdate)
Specify to force the ref update in case of a branch switch.CheckoutCommand
setName(String name)
Specify the name of the branch or commit to check out, or the new branch name.CheckoutCommand
setOrphan(boolean orphan)
Specify whether to create a new orphan branch.CheckoutCommand
setProgressMonitor(ProgressMonitor monitor)
CheckoutCommand
setStage(CheckoutCommand.Stage stage)
When checking out the index, check out the specified stage (ours or theirs) for unmerged paths.CheckoutCommand
setStartPoint(String startPoint)
Set the name of the commit that should be checked out.CheckoutCommand
setStartPoint(RevCommit startCommit)
Set the commit that should be checked out.CheckoutCommand
setUpstreamMode(CreateBranchCommand.SetupUpstreamMode mode)
When creating a branch withsetCreateBranch(boolean)
, this can be used to configure branch tracking.-
Methods inherited from class org.eclipse.jgit.api.GitCommand
checkCallable, getRepository, setCallable
-
-
-
-
Constructor Detail
-
CheckoutCommand
protected CheckoutCommand(Repository repo)
Constructor for CheckoutCommand- Parameters:
repo
- theRepository
-
-
Method Detail
-
call
public Ref call() throws GitAPIException, RefAlreadyExistsException, RefNotFoundException, InvalidRefNameException, CheckoutConflictException
Execute the command
- Specified by:
call
in interfaceCallable<Ref>
- Specified by:
call
in classGitCommand<Ref>
- Throws:
GitAPIException
RefAlreadyExistsException
RefNotFoundException
InvalidRefNameException
CheckoutConflictException
-
setProgressMonitor
public CheckoutCommand setProgressMonitor(ProgressMonitor monitor)
- Parameters:
monitor
- a progress monitor- Returns:
- this instance
- Since:
- 4.11
-
addPath
public CheckoutCommand addPath(String path)
Add a single slash-separated path to the list of paths to check out. To check out all paths, usesetAllPaths(boolean)
.If this option is set, neither the
setCreateBranch(boolean)
norsetName(String)
option is considered. In other words, these options are exclusive.- Parameters:
path
- path to update in the working tree and index (with/
as separator)- Returns:
this
-
addPaths
public CheckoutCommand addPaths(List<String> p)
Add multiple slash-separated paths to the list of paths to check out. To check out all paths, usesetAllPaths(boolean)
.If this option is set, neither the
setCreateBranch(boolean)
norsetName(String)
option is considered. In other words, these options are exclusive.- Parameters:
p
- paths to update in the working tree and index (with/
as separator)- Returns:
this
- Since:
- 4.6
-
setAllPaths
public CheckoutCommand setAllPaths(boolean all)
Set whether to checkout all paths.This options should be used when you want to do a path checkout on the entire repository and so calling
addPath(String)
is not possible since empty paths are not allowed.If this option is set, neither the
setCreateBranch(boolean)
norsetName(String)
option is considered. In other words, these options are exclusive.- Parameters:
all
-true
to checkout all paths,false
otherwise- Returns:
this
- Since:
- 2.0
-
checkoutPaths
protected CheckoutCommand checkoutPaths() throws IOException, RefNotFoundException
Checkout paths into index and working directory, firing aWorkingTreeModifiedEvent
if the working tree was modified.- Returns:
- this instance
- Throws:
IOException
RefNotFoundException
-
setName
public CheckoutCommand setName(String name)
Specify the name of the branch or commit to check out, or the new branch name.When only checking out paths and not switching branches, use
setStartPoint(String)
orsetStartPoint(RevCommit)
to specify from which branch or commit to check out files.When
setCreateBranch(boolean)
is set totrue
, use this method to set the name of the new branch to create andsetStartPoint(String)
orsetStartPoint(RevCommit)
to specify the start point of the branch.- Parameters:
name
- the name of the branch or commit- Returns:
- this instance
-
setCreateBranch
public CheckoutCommand setCreateBranch(boolean createBranch)
Specify whether to create a new branch.If
true
is used, the name of the new branch must be set usingsetName(String)
. The commit at which to start the new branch can be set usingsetStartPoint(String)
orsetStartPoint(RevCommit)
; if not specified, HEAD is used. Also seesetUpstreamMode(org.eclipse.jgit.api.CreateBranchCommand.SetupUpstreamMode)
for setting up branch tracking.- Parameters:
createBranch
- iftrue
a branch will be created as part of the checkout and set to the specified start point- Returns:
- this instance
-
setOrphan
public CheckoutCommand setOrphan(boolean orphan)
Specify whether to create a new orphan branch.If
true
is used, the name of the new orphan branch must be set usingsetName(String)
. The commit at which to start the new orphan branch can be set usingsetStartPoint(String)
orsetStartPoint(RevCommit)
; if not specified, HEAD is used.- Parameters:
orphan
- iftrue
a orphan branch will be created as part of the checkout to the specified start point- Returns:
- this instance
- Since:
- 3.3
-
setForce
@Deprecated public CheckoutCommand setForce(boolean force)
Deprecated.this method was badly named comparing its semantics to native git's checkout --force option, usesetForceRefUpdate(boolean)
insteadSpecify to force the ref update in case of a branch switch.- Parameters:
force
- iftrue
and the branch with the given name already exists, the start-point of an existing branch will be set to a new start-point; if false, the existing branch will not be changed- Returns:
- this instance
-
setForceRefUpdate
public CheckoutCommand setForceRefUpdate(boolean forceRefUpdate)
Specify to force the ref update in case of a branch switch. In releases prior to 5.2 this method was called setForce() but this name was misunderstood to implement native git's --force option, which is not true.- Parameters:
forceRefUpdate
- iftrue
and the branch with the given name already exists, the start-point of an existing branch will be set to a new start-point; if false, the existing branch will not be changed- Returns:
- this instance
- Since:
- 5.3
-
setForced
public CheckoutCommand setForced(boolean forced)
Allow a checkout even if the workingtree or index differs from HEAD. This matches native git's '--force' option. JGit releases before 5.2 had a methodsetForce()
offering semantics different from this newsetForced()
. This old semantic can now be found insetForceRefUpdate(boolean)
- Parameters:
forced
- if set totrue
then allow the checkout even if workingtree or index doesn't match HEAD. Overwrite workingtree files and index content with the new content in this case.- Returns:
- this instance
- Since:
- 5.3
-
setStartPoint
public CheckoutCommand setStartPoint(String startPoint)
Set the name of the commit that should be checked out.When checking out files and this is not specified or
null
, the index is used.When creating a new branch, this will be used as the start point. If not specified or
null
, the current HEAD is used.- Parameters:
startPoint
- commit name to check out- Returns:
- this instance
-
setStartPoint
public CheckoutCommand setStartPoint(RevCommit startCommit)
Set the commit that should be checked out.When creating a new branch, this will be used as the start point. If not specified or
null
, the current HEAD is used.When checking out files and this is not specified or
null
, the index is used.- Parameters:
startCommit
- commit to check out- Returns:
- this instance
-
setUpstreamMode
public CheckoutCommand setUpstreamMode(CreateBranchCommand.SetupUpstreamMode mode)
When creating a branch withsetCreateBranch(boolean)
, this can be used to configure branch tracking.- Parameters:
mode
- corresponds to the --track/--no-track options; may benull
- Returns:
- this instance
-
setStage
public CheckoutCommand setStage(CheckoutCommand.Stage stage)
When checking out the index, check out the specified stage (ours or theirs) for unmerged paths.This can not be used when checking out a branch, only when checking out the index.
- Parameters:
stage
- the stage to check out- Returns:
- this
-
getResult
public CheckoutResult getResult()
Get the result, nevernull
- Returns:
- the result, never
null
-
-