Package org.eclipse.jgit.api
Class RevertCommand
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate MergeResult
private ProgressMonitor
private String
private MergeStrategy
Fields inherited from class org.eclipse.jgit.api.GitCommand
repo
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
RevertCommand
(Repository repo) Constructor for RevertCommand. -
Method Summary
Modifier and TypeMethodDescriptionprivate String
calculateOurName
(Ref headRef) call()
Get the result of a merge failureGet the list of successfully revertedRef
's.Get unmerged pathsinclude
(String name, AnyObjectId commit) Include a commit to be revertedinclude
(AnyObjectId commit) Include a commit to be revertedInclude aRef
to a commit to be revertedsetOurCommitName
(String ourCommitName) Set the name to be used in the "OURS" place for conflict markerssetProgressMonitor
(ProgressMonitor monitor) The progress monitor associated with the revert operation.setStrategy
(MergeStrategy strategy) Set the merge strategy to use for this revert commandMethods inherited from class org.eclipse.jgit.api.GitCommand
checkCallable, getRepository, setCallable
-
Field Details
-
commits
-
ourCommitName
-
revertedRefs
-
failingResult
-
unmergedPaths
-
strategy
-
monitor
-
-
Constructor Details
-
RevertCommand
Constructor for RevertCommand.
- Parameters:
repo
- theRepository
-
-
Method Details
-
call
public RevCommit call() throws NoMessageException, UnmergedPathsException, ConcurrentRefUpdateException, WrongRepositoryStateException, GitAPIExceptionExecute 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 interfaceCallable<RevCommit>
- Specified by:
call
in classGitCommand<RevCommit>
- Throws:
NoMessageException
UnmergedPathsException
ConcurrentRefUpdateException
WrongRepositoryStateException
GitAPIException
-
include
Include aRef
to a commit to be reverted- Parameters:
commit
- a reference to a commit to be reverted into the current head- Returns:
this
-
include
Include a commit to be reverted- Parameters:
commit
- the Id of a commit to be reverted into the current head- Returns:
this
-
include
Include a commit to be reverted- Parameters:
name
- name of aRef
referring to the commitcommit
- the Id of a commit which is reverted into the current head- Returns:
this
-
setOurCommitName
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
-
calculateOurName
-
getRevertedRefs
Get the list of successfully revertedRef
's.- Returns:
- the list of successfully reverted
Ref
's. Nevernull
but maybe an empty list if no commit was successfully cherry-picked
-
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
Get unmerged paths- Returns:
- the unmerged paths, will be null if no merge conflicts
-
setStrategy
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
-
setProgressMonitor
The progress monitor associated with the revert operation. By default, this is set toNullProgressMonitor
- Parameters:
monitor
- aProgressMonitor
- Returns:
this
- Since:
- 4.11
- See Also:
-