org.eclipse.jgit.api

Class StashApplyCommand

java.lang.Object

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

org.eclipse.jgit.api.StashApplyCommand

All Implemented Interfaces:

Callable<ObjectId>

public class StashApplyCommand
extends GitCommand<ObjectId>

Command class to apply a stashed commit. This class behaves like git stash apply --index, i.e. it tries to recover the stashed index state in addition to the working tree state.

Since:

2.0

See Also:

Git documentation about Stash

Field Summary

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

repo

Constructor Summary

Constructors

Constructor and Description
StashApplyCommand(Repository repo) Create command to apply the changes of a stashed commit

Method Summary

Modifier and Type	Method and Description
ObjectId	call()
StashApplyCommand	ignoreRepositoryState(boolean willIgnoreRepositoryState) Whether to ignore the repository state when applying the stash
void	setApplyIndex(boolean applyIndex) Whether to restore the index state
void	setApplyUntracked(boolean applyUntracked) Whether the command should restore untracked files
StashApplyCommand	setStashRef(String stashRef) Set the stash reference to apply
StashApplyCommand	setStrategy(MergeStrategy strategy) Set the MergeStrategy to use.

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

Constructor Detail

StashApplyCommand

public StashApplyCommand(Repository repo)

Create command to apply the changes of a stashed commit

Parameters:

repo - the Repository to apply the stash to

Method Detail

setStashRef

public StashApplyCommand setStashRef(String stashRef)

Set the stash reference to apply

This will default to apply the latest stashed commit (stash@{0}) if unspecified

Parameters:

stashRef - name of the stash Ref to apply

Returns:

this

ignoreRepositoryState

public StashApplyCommand ignoreRepositoryState(boolean willIgnoreRepositoryState)

Whether to ignore the repository state when applying the stash

Parameters:

willIgnoreRepositoryState - whether to ignore the repository state when applying the stash

Returns:

this

Since:

3.2

call

public ObjectId call()
              throws GitAPIException,
                     WrongRepositoryStateException,
                     NoHeadException,
                     StashApplyFailureException

Execute the command

Apply the changes in a stashed commit to the working directory and index

Specified by:

call in interface Callable<ObjectId>

Specified by:

call in class GitCommand<ObjectId>

Throws:

GitAPIException

WrongRepositoryStateException

NoHeadException

StashApplyFailureException

setApplyIndex

public void setApplyIndex(boolean applyIndex)

Whether to restore the index state

Parameters:

applyIndex - true (default) if the command should restore the index state

setStrategy

public StashApplyCommand setStrategy(MergeStrategy strategy)

Set the MergeStrategy to use.

Parameters:

strategy - The merge strategy to use in order to merge during this command execution.

Returns:

this

Since:

3.4

setApplyUntracked

public void setApplyUntracked(boolean applyUntracked)

Whether the command should restore untracked files

Parameters:

applyUntracked - true (default) if the command should restore untracked files

Since:

3.4