org.eclipse.jgit.api

Class ResetCommand

java.lang.Object

org.eclipse.jgit.api.GitCommand<Ref>

org.eclipse.jgit.api.ResetCommand

All Implemented Interfaces:

Callable<Ref>

public class ResetCommand
extends GitCommand<Ref>

A class used to execute a Reset 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:

Git documentation about Reset

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResetCommand.ResetType Kind of reset

Field Summary

Fields inherited from class org.eclipse.jgit.api.GitCommand

repo

Constructor Summary

Constructors

Constructor and Description
ResetCommand(Repository repo) Constructor for ResetCommand.

Method Summary

Modifier and Type	Method and Description
ResetCommand	addPath(String path) Repository relative path of file or directory to reset
Ref	call()
ResetCommand	disableRefLog(boolean disable) Whether to disable reflog
boolean	isReflogDisabled() Whether reflog is disabled
ResetCommand	setMode(ResetCommand.ResetType mode) Set the reset mode
ResetCommand	setProgressMonitor(ProgressMonitor monitor) The progress monitor associated with the reset operation.
ResetCommand	setRef(String ref) Set the name of the Ref to reset to
String	toString()

Methods inherited from class org.eclipse.jgit.api.GitCommand

checkCallable, getRepository, setCallable

Methods inherited from class java.lang.Object

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

Constructor Detail

ResetCommand

public ResetCommand(Repository repo)

Constructor for ResetCommand.

Parameters:

repo - the Repository

Method Detail

call

public Ref call()
         throws GitAPIException,
                CheckoutConflictException

Execute the command

Executes the Reset command. 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<Ref>

Specified by:

call in class GitCommand<Ref>

Throws:

GitAPIException

CheckoutConflictException

setRef

public ResetCommand setRef(String ref)

Set the name of the Ref to reset to

Parameters:

ref - the ref to reset to, defaults to HEAD if not specified

Returns:

this instance

setMode

public ResetCommand setMode(ResetCommand.ResetType mode)

Set the reset mode

Parameters:

mode - the mode of the reset command

Returns:

this instance

addPath

public ResetCommand addPath(String path)

Repository relative path of file or directory to reset

Parameters:

path - repository-relative path of file/directory to reset (with / as separator)

Returns:

this instance

disableRefLog

public ResetCommand disableRefLog(boolean disable)

Whether to disable reflog

Parameters:

disable - if true disables writing a reflog entry for this reset command

Returns:

this instance

Since:

4.5

isReflogDisabled

public boolean isReflogDisabled()

Whether reflog is disabled

Returns:

true if writing reflog is disabled for this reset command

Since:

4.5

setProgressMonitor

public ResetCommand setProgressMonitor(ProgressMonitor monitor)

The progress monitor associated with the reset operation. By default, this is set to NullProgressMonitor

Parameters:

monitor - a ProgressMonitor

Returns:

this

Since:

4.11

See Also:

NullProgressMonitor

toString

public String toString()

Overrides:

toString in class Object