org.eclipse.jgit.api

Class RevertCommand

java.lang.Object

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

org.eclipse.jgit.api.RevertCommand

All Implemented Interfaces:

Callable<RevCommit>

public class RevertCommand
extends GitCommand<RevCommit>

A class used to execute a revert 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 revert

Field Summary

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

repo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RevertCommand(Repository repo) Constructor for RevertCommand.

Method Summary

Modifier and Type	Method and Description
RevCommit	call()
MergeResult	getFailingResult() Get the result of a merge failure
List<Ref>	getRevertedRefs() Get the list of successfully reverted Ref's.
List<String>	getUnmergedPaths() Get unmerged paths
RevertCommand	include(AnyObjectId commit) Include a commit to be reverted
RevertCommand	include(Ref commit) Include a Ref to a commit to be reverted
RevertCommand	include(String name, AnyObjectId commit) Include a commit to be reverted
RevertCommand	setOurCommitName(String ourCommitName) Set the name to be used in the "OURS" place for conflict markers
RevertCommand	setStrategy(MergeStrategy strategy) Set the merge strategy to use for this revert command

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, toString, wait, wait, wait

Constructor Detail

RevertCommand

protected RevertCommand(Repository repo)

Constructor for RevertCommand.

Parameters:

repo - the Repository

Method Detail

call

public RevCommit call()
               throws NoMessageException,
                      UnmergedPathsException,
                      ConcurrentRefUpdateException,
                      WrongRepositoryStateException,
                      GitAPIException

Execute the command

Executes the revert 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<RevCommit>

Specified by:

call in class GitCommand<RevCommit>

Throws:

NoMessageException

UnmergedPathsException

ConcurrentRefUpdateException

WrongRepositoryStateException

GitAPIException

include

public RevertCommand include(Ref commit)

Include a Ref to a commit to be reverted

Parameters:

commit - a reference to a commit to be reverted into the current head

Returns:

this

include

public RevertCommand include(AnyObjectId commit)

Include a commit to be reverted

Parameters:

commit - the Id of a commit to be reverted into the current head

Returns:

this

include

public RevertCommand include(String name,
                             AnyObjectId commit)

Include a commit to be reverted

Parameters:

name - name of a Ref referring to the commit

commit - the Id of a commit which is reverted into the current head

Returns:

this

setOurCommitName

public RevertCommand setOurCommitName(String ourCommitName)

Set the name to 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

getRevertedRefs

public List<Ref> getRevertedRefs()

Get the list of successfully reverted Ref's.

Returns:

the list of successfully reverted Ref's. Never null but maybe an empty list if no commit was successfully cherry-picked

getFailingResult

public MergeResult getFailingResult()

Get the result of a merge failure

Returns:

the result of a merge failure, null if no merge failure occurred during the revert

getUnmergedPaths

public List<String> getUnmergedPaths()

Get unmerged paths

Returns:

the unmerged paths, will be null if no merge conflicts

setStrategy

public RevertCommand setStrategy(MergeStrategy strategy)

Set the merge strategy to use for this revert command

Parameters:

strategy - The merge strategy to use for this revert command.

Returns:

this

Since:

3.4