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:

  • Field Details

  • Constructor Details

    • RevertCommand

      protected RevertCommand(Repository repo)

      Constructor for RevertCommand.

      Parameters:
      repo - the Repository

  • Method Details

    • 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

    • calculateOurName

      private String calculateOurName(Ref headRef)

    • 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

    • setProgressMonitor

      public RevertCommand setProgressMonitor(ProgressMonitor monitor)
      The progress monitor associated with the revert operation. By default, this is set to NullProgressMonitor
      Parameters:
      monitor - a ProgressMonitor
      Returns:
      this
      Since:
      4.11
      See Also: