org.eclipse.jgit.api

Class CherryPickCommand

java.lang.Object

org.eclipse.jgit.api.GitCommand<CherryPickResult>

org.eclipse.jgit.api.CherryPickCommand

All Implemented Interfaces:

Callable<CherryPickResult>

public class CherryPickCommand
extends GitCommand<CherryPickResult>

A class used to execute a cherry-pick command. It has setters for all supported options and arguments of this command and a call() method to finally execute the command. Each instance of this class should only be used for one invocation of the command (means: one call to call())

See Also:

Git documentation about cherry-pick

Field Summary

Fields inherited from class org.eclipse.jgit.api.GitCommand

repo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CherryPickCommand(Repository repo) Constructor for CherryPickCommand

Method Summary

Modifier and Type	Method and Description
CherryPickResult	call()
CherryPickCommand	include(AnyObjectId commit) Include a commit
CherryPickCommand	include(Ref commit) Include a reference to a commit
CherryPickCommand	include(String name, AnyObjectId commit) Include a commit
CherryPickCommand	setMainlineParentNumber(int mainlineParentNumber) Set the (1-based) parent number to diff against
CherryPickCommand	setNoCommit(boolean noCommit) Allows cherry-picking changes without committing them.
CherryPickCommand	setOurCommitName(String ourCommitName) Set the name that should be used in the "OURS" place for conflict markers
CherryPickCommand	setProgressMonitor(ProgressMonitor monitor) The progress monitor associated with the cherry-pick operation.
CherryPickCommand	setReflogPrefix(String prefix) Set the prefix to use in the reflog.
CherryPickCommand	setStrategy(MergeStrategy strategy) Set the MergeStrategy
String	toString()

Methods inherited from class org.eclipse.jgit.api.GitCommand

checkCallable, getRepository, setCallable

Methods inherited from class java.lang.Object

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

Constructor Detail

CherryPickCommand

protected CherryPickCommand(Repository repo)

Constructor for CherryPickCommand

Parameters:

repo - the Repository

Method Detail

call

public CherryPickResult call()
                      throws GitAPIException,
                             NoMessageException,
                             UnmergedPathsException,
                             ConcurrentRefUpdateException,
                             WrongRepositoryStateException,
                             NoHeadException

Execute the command

Executes the Cherry-Pick command with all the options and parameters collected by the setter methods (e.g. include(Ref) of this class. Each instance of this class should only be used for one invocation of the command. Don't call this method twice on an instance.

Specified by:

call in interface Callable<CherryPickResult>

Specified by:

call in class GitCommand<CherryPickResult>

Throws:

GitAPIException

NoMessageException

UnmergedPathsException

ConcurrentRefUpdateException

WrongRepositoryStateException

NoHeadException

include

public CherryPickCommand include(Ref commit)

Include a reference to a commit

Parameters:

commit - a reference to a commit which is cherry-picked to the current head

Returns:

this

include

public CherryPickCommand include(AnyObjectId commit)

Include a commit

Parameters:

commit - the Id of a commit which is cherry-picked to the current head

Returns:

this

include

public CherryPickCommand include(String name,
                                 AnyObjectId commit)

Include a commit

Parameters:

name - a name given to the commit

commit - the Id of a commit which is cherry-picked to the current head

Returns:

this

setOurCommitName

public CherryPickCommand setOurCommitName(String ourCommitName)

Set the name that should be used in the "OURS" place for conflict markers

Parameters:

ourCommitName - the name that should be used in the "OURS" place for conflict markers

Returns:

this

setReflogPrefix

public CherryPickCommand setReflogPrefix(String prefix)

Set the prefix to use in the reflog.

This is primarily needed for implementing rebase in terms of cherry-picking

Parameters:

prefix - including ":"

Returns:

this

Since:

3.1

setStrategy

public CherryPickCommand setStrategy(MergeStrategy strategy)

Set the MergeStrategy

Parameters:

strategy - The merge strategy to use during this Cherry-pick.

Returns:

this

Since:

3.4

setMainlineParentNumber

public CherryPickCommand setMainlineParentNumber(int mainlineParentNumber)

Set the (1-based) parent number to diff against

Parameters:

mainlineParentNumber - the (1-based) parent number to diff against. This allows cherry-picking of merges.

Returns:

this

Since:

3.4

setNoCommit

public CherryPickCommand setNoCommit(boolean noCommit)

Allows cherry-picking changes without committing them.

NOTE: The behavior of cherry-pick is undefined if you pick multiple commits or if HEAD does not match the index state before cherry-picking.

Parameters:

noCommit - true to cherry-pick without committing, false to commit after each pick (default)

Returns:

this

Since:

3.5

setProgressMonitor

public CherryPickCommand setProgressMonitor(ProgressMonitor monitor)

The progress monitor associated with the cherry-pick operation. By default, this is set to NullProgressMonitor

Parameters:

monitor - a ProgressMonitor

Returns:

this

Since:

4.11

See Also:

NullProgressMonitor

toString

public String toString()

Overrides:

toString in class Object