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

Modifier and Type	Field and Description
private boolean	directories
private boolean	dryRun
private boolean	force
private boolean	ignore
private Set<String>	paths

Access	Constructor and Description
protected	CleanCommand(Repository the `org.eclipse.jgit.lib.Repository` repo) Constructor for CleanCommand

Method Summary

Modifier and Type	Method and Description
public Set<String>	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 Set<String>	Returns: a set of strings with the cleaned path added to it cleanPath(String The path to be cleaned path, Set<String> A set of strings representing the files that have been cleaned already, the path to be cleaned will be added to this set before being returned. inFiles) When dryRun is false, deletes the specified path from disk.
private Set<String>	filterFolders(Set<String> untracked, Set<String> untrackedFolders)
private Set<String>	filterIgnorePaths(Set<String> inputPaths, Set<String> ignoredNotInIndex, boolean exact)
public CleanCommand	Returns: `this` setCleanDirectories(boolean whether to clean directories too, or only files. dirs) If dirs is set, in addition to files, also clean directories.
public CleanCommand	Returns: `this` setDryRun(boolean whether to do a dry run or not dryRun) If dryRun is set, the paths in question will not actually be deleted.
public CleanCommand	Returns: `this` setForce(boolean whether or not to delete git repositories force) If force is set, directories that are git repositories will also be deleted.
public CleanCommand	Returns: `this` setIgnore(boolean whether to respect .gitignore or not. ignore) If ignore is set, don't report/clean files/directories that are ignored by a .gitignore.
public CleanCommand	Returns: `this` setPaths(Set<String> the paths to set (with `/` as separator) paths) If paths are set, only these paths are affected by the cleaning.

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

directories	back to summary
private boolean directories

dryRun	back to summary
private boolean dryRun

force	back to summary
private boolean force

ignore	back to summary
private boolean ignore

paths	back to summary
private Set<String> paths

CleanCommand	back to summary
protected CleanCommand(Repository repo) Constructor for CleanCommand Parameters repo:Repository the `org.eclipse.jgit.lib.Repository`

Method Detail

call back to summary

call	back to summary
public Set<String> call() throws NoWorkTreeException, 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 Executes the `clean` 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 (means: one call to `call()`) Returns:Set<String> Doc from java.util.concurrent.Callable.call. computed result Annotations @Override

public Set<String> call() throws NoWorkTreeException, 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

Executes the clean 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 (means: one call to call())

Returns:Set<String>

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

computed result

Annotations

@Override

cleanPath back to summary

cleanPath	back to summary
private Set<String> cleanPath(String path, Set<String> inFiles) throws IOException When dryRun is false, deletes the specified path from disk. If dryRun is true, no paths are actually deleted. In both cases, the paths that would have been deleted are added to inFiles and returned. Paths that are directories are recursively deleted when `directories` is true. Paths that are git repositories are recursively deleted when `directories` and `force` are both true. Parameters path:String The path to be cleaned inFiles:Set<String> A set of strings representing the files that have been cleaned already, the path to be cleaned will be added to this set before being returned. Returns:Set<String> a set of strings with the cleaned path added to it Exceptions IOException: if an IO error occurred

private Set<String> cleanPath(String path, Set<String> inFiles) throws IOException

When dryRun is false, deletes the specified path from disk. If dryRun is true, no paths are actually deleted. In both cases, the paths that would have been deleted are added to inFiles and returned. Paths that are directories are recursively deleted when directories is true. Paths that are git repositories are recursively deleted when directories and force are both true.

Parameters

path:String: The path to be cleaned
inFiles:Set<String>: A set of strings representing the files that have been cleaned already, the path to be cleaned will be added to this set before being returned.

Returns:Set<String>

a set of strings with the cleaned path added to it

Exceptions

IOException:: if an IO error occurred

filterFolders	back to summary
private Set<String> filterFolders(Set<String> untracked, Set<String> untrackedFolders)

filterIgnorePaths	back to summary
private Set<String> filterIgnorePaths(Set<String> inputPaths, Set<String> ignoredNotInIndex, boolean exact)

setCleanDirectories back to summary

setCleanDirectories	back to summary
public CleanCommand setCleanDirectories(boolean dirs) If dirs is set, in addition to files, also clean directories. Parameters dirs:boolean whether to clean directories too, or only files. Returns:CleanCommand `this`

public CleanCommand setCleanDirectories(boolean dirs)

If dirs is set, in addition to files, also clean directories.

Parameters

dirs:boolean: whether to clean directories too, or only files.

Returns:CleanCommand

this

setDryRun back to summary

setDryRun	back to summary
public CleanCommand setDryRun(boolean dryRun) If dryRun is set, the paths in question will not actually be deleted. Parameters dryRun:boolean whether to do a dry run or not Returns:CleanCommand `this`

public CleanCommand setDryRun(boolean dryRun)

If dryRun is set, the paths in question will not actually be deleted.

Parameters

dryRun:boolean: whether to do a dry run or not

Returns:CleanCommand

this

setForce back to summary

setForce	back to summary
public CleanCommand setForce(boolean force) If force is set, directories that are git repositories will also be deleted. Parameters force:boolean whether or not to delete git repositories Returns:CleanCommand `this` Since 4.5

public CleanCommand setForce(boolean force)

If force is set, directories that are git repositories will also be deleted.

Parameters

force:boolean: whether or not to delete git repositories

Returns:CleanCommand

this

Since

4.5

setIgnore back to summary

setIgnore	back to summary
public CleanCommand setIgnore(boolean ignore) If ignore is set, don't report/clean files/directories that are ignored by a .gitignore. otherwise do handle them. Parameters ignore:boolean whether to respect .gitignore or not. Returns:CleanCommand `this`

public CleanCommand setIgnore(boolean ignore)

If ignore is set, don't report/clean files/directories that are ignored by a .gitignore. otherwise do handle them.

Parameters

ignore:boolean: whether to respect .gitignore or not.

Returns:CleanCommand

this

setPaths back to summary

setPaths	back to summary
public CleanCommand setPaths(Set<String> paths) If paths are set, only these paths are affected by the cleaning. Parameters paths:Set<String> the paths to set (with `/` as separator) Returns:CleanCommand `this`

public CleanCommand setPaths(Set<String> paths)

If paths are set, only these paths are affected by the cleaning.

Parameters

paths:Set<String>: the paths to set (with / as separator)

Returns:CleanCommand

this

public Class CleanCommand

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail