Package org.eclipse.jgit.api
Class StashApplyCommand
- java.lang.Object
-
- org.eclipse.jgit.api.GitCommand<ObjectId>
-
- org.eclipse.jgit.api.StashApplyCommand
-
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 Description StashApplyCommand(Repository repo)
Create command to apply the changes of a stashed commit
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ObjectId
call()
StashApplyCommand
ignoreRepositoryState(boolean willIgnoreRepositoryState)
Whether to ignore the repository state when applying the stashvoid
setApplyIndex(boolean applyIndex)
Deprecated.usesetRestoreIndex(boolean)
insteadvoid
setApplyUntracked(boolean applyUntracked)
Deprecated.usesetRestoreUntracked(boolean)
insteadStashApplyCommand
setContentMergeStrategy(ContentMergeStrategy strategy)
Sets the content merge strategy to use if themerge strategy
is "resolve" or "recursive".StashApplyCommand
setRestoreIndex(boolean restoreIndex)
Whether to restore the index stateStashApplyCommand
setRestoreUntracked(boolean restoreUntracked)
Whether the command should restore untracked filesStashApplyCommand
setStashRef(String stashRef)
Set the stash reference to applyStashApplyCommand
setStrategy(MergeStrategy strategy)
Set theMergeStrategy
to use.-
Methods inherited from class org.eclipse.jgit.api.GitCommand
checkCallable, getRepository, setCallable
-
-
-
-
Constructor Detail
-
StashApplyCommand
public StashApplyCommand(Repository repo)
Create command to apply the changes of a stashed commit- Parameters:
repo
- theRepository
to apply the stash to
-
-
Method Detail
-
setStashRef
public StashApplyCommand setStashRef(String stashRef)
Set the stash reference to applyThis will default to apply the latest stashed commit (stash@{0}) if unspecified
- Parameters:
stashRef
- name of the stashRef
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 interfaceCallable<ObjectId>
- Specified by:
call
in classGitCommand<ObjectId>
- Throws:
GitAPIException
WrongRepositoryStateException
NoHeadException
StashApplyFailureException
-
setApplyIndex
@Deprecated public void setApplyIndex(boolean applyIndex)
Deprecated.usesetRestoreIndex(boolean)
insteadWhether to restore the index state- Parameters:
applyIndex
- true (default) if the command should restore the index state
-
setRestoreIndex
public StashApplyCommand setRestoreIndex(boolean restoreIndex)
Whether to restore the index state- Parameters:
restoreIndex
- true (default) if the command should restore the index state- Returns:
this
- Since:
- 5.3
-
setStrategy
public StashApplyCommand setStrategy(MergeStrategy strategy)
Set theMergeStrategy
to use.- Parameters:
strategy
- The merge strategy to use in order to merge during this command execution.- Returns:
this
- Since:
- 3.4
-
setContentMergeStrategy
public StashApplyCommand setContentMergeStrategy(ContentMergeStrategy strategy)
Sets the content merge strategy to use if themerge strategy
is "resolve" or "recursive".- Parameters:
strategy
- theContentMergeStrategy
to be used- Returns:
this
- Since:
- 5.12
-
setApplyUntracked
@Deprecated public void setApplyUntracked(boolean applyUntracked)
Deprecated.usesetRestoreUntracked(boolean)
insteadWhether the command should restore untracked files- Parameters:
applyUntracked
- true (default) if the command should restore untracked files- Since:
- 3.4
-
setRestoreUntracked
public StashApplyCommand setRestoreUntracked(boolean restoreUntracked)
Whether the command should restore untracked files- Parameters:
restoreUntracked
- true (default) if the command should restore untracked files- Returns:
this
- Since:
- 5.3
-
-