Class DiffCommand

All Implemented Interfaces:
Callable<List<DiffEntry>>

public class DiffCommand extends GitCommand<List<DiffEntry>>
Show changes between commits, commit and working tree, etc.
See Also:
  • Field Details

  • Constructor Details

    • DiffCommand

      protected DiffCommand(Repository repo)
      Constructor for DiffCommand
      Parameters:
      repo - a Repository object.
  • Method Details

    • getDiffFormatter

      private DiffFormatter getDiffFormatter()
    • call

      public List<DiffEntry> call() throws GitAPIException

      Execute the command

      Executes the Diff command with all the options and parameters collected by the setter methods (e.g. setCached(boolean) 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<List<DiffEntry>>
      Specified by:
      call in class GitCommand<List<DiffEntry>>
      Throws:
      GitAPIException
    • setCached

      public DiffCommand setCached(boolean cached)
      Whether to view the changes staged for the next commit
      Parameters:
      cached - whether to view the changes staged for the next commit
      Returns:
      this instance
    • setPathFilter

      public DiffCommand setPathFilter(TreeFilter pathFilter)
      Set path filter
      Parameters:
      pathFilter - parameter, used to limit the diff to the named path
      Returns:
      this instance
    • setOldTree

      public DiffCommand setOldTree(AbstractTreeIterator oldTree)
      Set old tree
      Parameters:
      oldTree - the previous state
      Returns:
      this instance
    • setNewTree

      public DiffCommand setNewTree(AbstractTreeIterator newTree)
      Set new tree
      Parameters:
      newTree - the updated state
      Returns:
      this instance
    • setShowNameAndStatusOnly

      public DiffCommand setShowNameAndStatusOnly(boolean showNameAndStatusOnly)
      Set whether to return only names and status of changed files
      Parameters:
      showNameAndStatusOnly - whether to return only names and status of changed files
      Returns:
      this instance
    • setOutputStream

      public DiffCommand setOutputStream(OutputStream out)
      Set output stream
      Parameters:
      out - the stream to write line data
      Returns:
      this instance
    • setContextLines

      public DiffCommand setContextLines(int contextLines)
      Set number of context lines instead of the usual three.
      Parameters:
      contextLines - the number of context lines
      Returns:
      this instance
    • setSourcePrefix

      public DiffCommand setSourcePrefix(String sourcePrefix)
      Set the given source prefix instead of "a/".
      Parameters:
      sourcePrefix - the prefix
      Returns:
      this instance
    • setDestinationPrefix

      public DiffCommand setDestinationPrefix(String destinationPrefix)
      Set the given destination prefix instead of "b/".
      Parameters:
      destinationPrefix - the prefix
      Returns:
      this instance
    • setProgressMonitor

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