Package org.eclipse.jgit.internal.diffmergetool

Class UserDefinedDiffTool

java.lang.Object

org.eclipse.jgit.internal.diffmergetool.UserDefinedDiffTool

All Implemented Interfaces:

ExternalDiffTool

Direct Known Subclasses:

PreDefinedDiffTool, UserDefinedMergeTool

public class UserDefinedDiffTool
extends Object
implements ExternalDiffTool

The user-defined diff tool.

Constructor Summary

Constructors

Constructor	Description
UserDefinedDiffTool(String name, String path, String cmd)	Creates the diff tool

Method Summary

Modifier and Type	Method	Description
String	getCommand()	The command of the diff tool.
String	getName()
String	getPath()	The path of the diff tool.
boolean	isAvailable()
void	setAvailable(boolean available)
void	setPath(String path)	Overrides the path for the given tool.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDefinedDiffTool

public UserDefinedDiffTool(String name,
                           String path,
                           String cmd)

Creates the diff tool

Parameters:

name - the name

path - the path

cmd - the command

Method Detail

getName

public String getName()

Specified by:

getName in interface ExternalDiffTool

Returns:

the diff tool name

getPath

public String getPath()

The path of the diff tool.

The path to a pre-defined external diff tool can be overridden by specifying difftool.<tool>.path in a configuration file.

For a user defined diff tool (that does not override a pre-defined diff tool), the path is ignored when invoking the tool.

Specified by:

getPath in interface ExternalDiffTool

Returns:

the diff tool 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 getPath() and can sometimes include tool parameters.

Specified by:

getCommand in interface ExternalDiffTool

Returns:

the diff tool command

See Also:

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

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface ExternalDiffTool

Returns:

availability of the tool: true if tool can be executed and false if not

setAvailable

public void setAvailable(boolean available)

Parameters:

available - true if tool can be found and false if not

setPath

public void setPath(String path)

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

Parameters:

path - the new diff tool path

See Also:

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