JGit 7.2.0.202503040940-r · org.eclipse.jgit.api.StashDropCommand

public Class StashDropCommand

Command class to delete a stashed commit reference

Currently only supported on a traditional file repository using one-file-per-ref reflogs.

Field Summary

Modifier and Type	Field and Description
private boolean	all
private int	stashRefEntry

Inherited from org.eclipse.jgit.api.GitCommand:: repo

Constructor Summary

Access	Constructor and Description
public	StashDropCommand(Repository a `org.eclipse.jgit.lib.Repository` object. repo) Constructor for StashDropCommand.

Method Summary

Modifier and Type	Method and Description
public ObjectId	call() Implements abstract org.eclipse.jgit.api.GitCommand.call. Implements java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.
private RefUpdate	createRefUpdate(Ref stashRef)
private void	deleteRef(Ref stashRef)
private Ref	getRef()
public StashDropCommand	Returns: `this` setAll(boolean `true` to drop all stashed commits, `false` to drop only the stashed commit set via calling `setStashRef(int)` all) Set whether to drop all stashed commits
public StashDropCommand	Returns: `this` setStashRef(int the 0-based index of the stash reference stashRef) Set the stash reference to drop (0-based).
private void	updateRef(Ref stashRef, ObjectId newId)

Inherited from org.eclipse.jgit.api.GitCommand:: checkCallable getRepository setCallable

Field Detail

all	back to summary
private boolean all

stashRefEntry	back to summary
private int stashRefEntry

Constructor Detail

StashDropCommand back to summary

StashDropCommand	back to summary
public StashDropCommand(Repository repo) Constructor for StashDropCommand. Parameters repo:Repository a `org.eclipse.jgit.lib.Repository` object.

public StashDropCommand(Repository repo)

Constructor for StashDropCommand.

Parameters

repo:Repository: a org.eclipse.jgit.lib.Repository object.

Method Detail

call	back to summary
public ObjectId call() throws GitAPIException Implements abstract org.eclipse.jgit.api.GitCommand.call. Implements java.util.concurrent.Callable.call. Doc from org.eclipse.jgit.api.GitCommand.call. Computes a result, or throws an exception if unable to do so. Execute the command Drop the configured entry from the stash reflog and return value of the stash reference after the drop occurs Returns:ObjectId Doc from java.util.concurrent.Callable.call. computed result Annotations @Override

call

back to summary

public ObjectId call() throws GitAPIException

Implements abstract org.eclipse.jgit.api.GitCommand.call.

Implements java.util.concurrent.Callable.call.

Doc from org.eclipse.jgit.api.GitCommand.call.

Computes a result, or throws an exception if unable to do so.

Execute the command

Drop the configured entry from the stash reflog and return value of the stash reference after the drop occurs

Returns:ObjectId

Doc from java.util.concurrent.Callable.call.

computed result

Annotations

@Override

createRefUpdate	back to summary
private RefUpdate createRefUpdate(Ref stashRef) throws IOException

deleteRef	back to summary
private void deleteRef(Ref stashRef)

getRef	back to summary
private Ref getRef() throws GitAPIException

setAll back to summary

setAll	back to summary
public StashDropCommand setAll(boolean all) Set whether to drop all stashed commits Parameters all:boolean `true` to drop all stashed commits, `false` to drop only the stashed commit set via calling `setStashRef(int)` Returns:StashDropCommand `this`

public StashDropCommand setAll(boolean all)

Set whether to drop all stashed commits

Parameters

all:boolean: true to drop all stashed commits, false to drop only the stashed commit set via calling setStashRef(int)

Returns:StashDropCommand

this

setStashRef back to summary

setStashRef	back to summary
public StashDropCommand setStashRef(int stashRef) Set the stash reference to drop (0-based). This will default to drop the latest stashed commit (stash@{0}) if unspecified Parameters stashRef:int the 0-based index of the stash reference Returns:StashDropCommand `this`

public StashDropCommand setStashRef(int stashRef)

Set the stash reference to drop (0-based).

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

Parameters

stashRef:int: the 0-based index of the stash reference

Returns:StashDropCommand

this

updateRef	back to summary
private void updateRef(Ref stashRef, ObjectId newId)