Module org.eclipse.jgit

Package org.eclipse.jgit.internal.diffmergetool

Class PreDefinedDiffTool

java.lang.Object

org.eclipse.jgit.internal.diffmergetool.UserDefinedDiffTool

org.eclipse.jgit.internal.diffmergetool.PreDefinedDiffTool

All Implemented Interfaces:

ExternalDiffTool

public class PreDefinedDiffTool
extends UserDefinedDiffTool

The pre-defined diff tool.

Constructor Summary

Constructors

Constructor	Description
PreDefinedDiffTool(String name, String path, String parameters)	Create a pre-defined diff tool
PreDefinedDiffTool(CommandLineDiffTool tool)	Creates the pre-defined diff tool

Method Summary

Modifier and Type	Method	Description
String	getCommand()	The command of the diff tool.
void	setPath(String path)	Overrides the path for the given tool.

Methods inherited from class org.eclipse.jgit.internal.diffmergetool.UserDefinedDiffTool

getName, getPath, isAvailable, setAvailable

Methods inherited from class java.lang.Object

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

Constructor Detail

PreDefinedDiffTool

public PreDefinedDiffTool(String name,
                          String path,
                          String parameters)

Create a pre-defined diff tool

Parameters:

name - the name

path - the path

parameters - the tool parameters as one string that is used together with path as command

PreDefinedDiffTool

public PreDefinedDiffTool(CommandLineDiffTool tool)

Creates the pre-defined diff tool

Parameters:

tool - the command line diff tool

Method Detail

setPath

public void setPath(String path)

Description copied from class: UserDefinedDiffTool

Overrides the path for the given tool. Equivalent to setting difftool.<tool>.path.

Overrides:

setPath in class UserDefinedDiffTool

Parameters:

path -

See Also:

https://git-scm.com/docs/git-difftool

getCommand

public String getCommand()

The command of the diff tool.

A pre-defined external diff tool can be overridden using the tools name in a configuration file. The overwritten tool is then a user defined tool and the command of the diff tool is specified with difftool.<tool>.cmd. This command must work without prepending the value of UserDefinedDiffTool.getPath() and can sometimes include tool parameters.

Specified by:

getCommand in interface ExternalDiffTool

Overrides:

getCommand in class UserDefinedDiffTool

Returns:

the concatenated path and command of the pre-defined diff tool

See Also:

https://git-scm.com/docs/git-difftool