org.eclipse.jgit.api

Class RebaseCommand

java.lang.Object

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

org.eclipse.jgit.api.RebaseCommand

All Implemented Interfaces:

Callable<RebaseResult>

public class RebaseCommand
extends GitCommand<RebaseResult>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RebaseCommand.InteractiveHandler Allows configure rebase interactive process and modify commit message
static class	RebaseCommand.Operation The available operations

Field Summary

Fields

Modifier and Type	Field and Description
static String	REBASE_MERGE The name of the "rebase-merge" folder for interactive rebases.
static String	STOPPED_SHA The name of the "stopped-sha" file

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

repo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RebaseCommand(Repository repo) Constructor for RebaseCommand.

Method Summary

Modifier and Type	Method and Description
RebaseResult	call()
RebaseCommand	runInteractively(RebaseCommand.InteractiveHandler handler) Enable interactive rebase
RebaseCommand	runInteractively(RebaseCommand.InteractiveHandler handler, boolean stopAfterRebaseInteractiveInitialization) Enable interactive rebase
RebaseCommand	setOperation(RebaseCommand.Operation operation) Set the operation to execute during rebase
RebaseCommand	setPreserveMerges(boolean preserve) Whether to preserve merges during rebase
RebaseCommand	setProgressMonitor(ProgressMonitor monitor) Set progress monitor
RebaseCommand	setStrategy(MergeStrategy strategy) Set the MergeStrategy.
RebaseCommand	setUpstream(AnyObjectId upstream) Set the upstream commit
RebaseCommand	setUpstream(RevCommit upstream) Set upstream RevCommit
RebaseCommand	setUpstream(String upstream) Set the upstream branch
RebaseCommand	setUpstreamName(String upstreamName) Optionally override the name of the upstream.
RevCommit	tryFastForward(RevCommit newCommit) Check if we can fast-forward and returns the new head if it is possible

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, toString, wait, wait, wait

Field Detail

REBASE_MERGE

public static final String REBASE_MERGE

The name of the "rebase-merge" folder for interactive rebases.

See Also:

Constant Field Values

STOPPED_SHA

public static final String STOPPED_SHA

The name of the "stopped-sha" file

See Also:

Constant Field Values

Constructor Detail

RebaseCommand

protected RebaseCommand(Repository repo)

Constructor for RebaseCommand.

Parameters:

repo - the Repository

Method Detail

call

public RebaseResult call()
                  throws GitAPIException,
                         NoHeadException,
                         RefNotFoundException,
                         WrongRepositoryStateException

Execute the command

Executes the Rebase command with all the options and parameters collected by the setter methods 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<RebaseResult>

Specified by:

call in class GitCommand<RebaseResult>

Throws:

GitAPIException

NoHeadException

RefNotFoundException

WrongRepositoryStateException

tryFastForward

public RevCommit tryFastForward(RevCommit newCommit)
                         throws IOException,
                                GitAPIException

Check if we can fast-forward and returns the new head if it is possible

Parameters:

newCommit - a RevCommit object to check if we can fast-forward to.

Returns:

the new head, or null

Throws:

IOException

GitAPIException

setUpstream

public RebaseCommand setUpstream(RevCommit upstream)

Set upstream RevCommit

Parameters:

upstream - the upstream commit

Returns:

this

setUpstream

public RebaseCommand setUpstream(AnyObjectId upstream)

Set the upstream commit

Parameters:

upstream - id of the upstream commit

Returns:

this

setUpstream

public RebaseCommand setUpstream(String upstream)
                          throws RefNotFoundException

Set the upstream branch

Parameters:

upstream - the name of the upstream branch

Returns:

this

Throws:

RefNotFoundException

setUpstreamName

public RebaseCommand setUpstreamName(String upstreamName)

Optionally override the name of the upstream. If this is used, it has to come after any setUpstream(org.eclipse.jgit.revwalk.RevCommit) call.

Parameters:

upstreamName - the name which will be used to refer to upstream in conflicts

Returns:

this

setOperation

public RebaseCommand setOperation(RebaseCommand.Operation operation)

Set the operation to execute during rebase

Parameters:

operation - the operation to perform

Returns:

this

setProgressMonitor

public RebaseCommand setProgressMonitor(ProgressMonitor monitor)

Set progress monitor

Parameters:

monitor - a progress monitor

Returns:

this instance

runInteractively

public RebaseCommand runInteractively(RebaseCommand.InteractiveHandler handler)

Enable interactive rebase

Does not stop after initialization of interactive rebase. This is equivalent to runInteractively(handler, false);

Parameters:

handler - the RebaseCommand.InteractiveHandler to use

Returns:

this

runInteractively

public RebaseCommand runInteractively(RebaseCommand.InteractiveHandler handler,
                                      boolean stopAfterRebaseInteractiveInitialization)

Enable interactive rebase

If stopAfterRebaseInteractiveInitialization is true the rebase stops after initialization of interactive rebase returning RebaseResult.INTERACTIVE_PREPARED_RESULT

Parameters:

handler - the RebaseCommand.InteractiveHandler to use

stopAfterRebaseInteractiveInitialization - if true the rebase stops after initialization

Returns:

this instance

Since:

3.2

setStrategy

public RebaseCommand setStrategy(MergeStrategy strategy)

Set the MergeStrategy.

Parameters:

strategy - The merge strategy to use during this rebase operation.

Returns:

this

Since:

3.4

setPreserveMerges

public RebaseCommand setPreserveMerges(boolean preserve)

Whether to preserve merges during rebase

Parameters:

preserve - true to re-create merges during rebase. Defaults to false, a flattening rebase.

Returns:

this

Since:

3.5