Package org.eclipse.jgit.api
Class CleanCommand
- java.lang.Object
-
- org.eclipse.jgit.api.GitCommand<Set<String>>
-
- org.eclipse.jgit.api.CleanCommand
-
public class CleanCommand extends GitCommand<Set<String>>
Remove untracked files from the working tree- See Also:
- Git documentation about Clean
-
-
Field Summary
-
Fields inherited from class org.eclipse.jgit.api.GitCommand
repo
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CleanCommand(Repository repo)
Constructor for CleanCommand
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Set<String>
call()
CleanCommand
setCleanDirectories(boolean dirs)
If dirs is set, in addition to files, also clean directories.CleanCommand
setDryRun(boolean dryRun)
If dryRun is set, the paths in question will not actually be deleted.CleanCommand
setForce(boolean force)
If force is set, directories that are git repositories will also be deleted.CleanCommand
setIgnore(boolean ignore)
If ignore is set, don't report/clean files/directories that are ignored by a .gitignore.CleanCommand
setPaths(Set<String> paths)
If paths are set, only these paths are affected by the cleaning.-
Methods inherited from class org.eclipse.jgit.api.GitCommand
checkCallable, getRepository, setCallable
-
-
-
-
Constructor Detail
-
CleanCommand
protected CleanCommand(Repository repo)
Constructor for CleanCommand- Parameters:
repo
- theRepository
-
-
Method Detail
-
call
public Set<String> call() throws NoWorkTreeException, GitAPIException
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 tocall()
)- Specified by:
call
in interfaceCallable<Set<String>>
- Specified by:
call
in classGitCommand<Set<String>>
- Throws:
NoWorkTreeException
GitAPIException
-
setPaths
public CleanCommand setPaths(Set<String> paths)
If paths are set, only these paths are affected by the cleaning.- Parameters:
paths
- the paths to set (with/
as separator)- Returns:
this
-
setDryRun
public CleanCommand setDryRun(boolean dryRun)
If dryRun is set, the paths in question will not actually be deleted.- Parameters:
dryRun
- whether to do a dry run or not- Returns:
this
-
setForce
public CleanCommand setForce(boolean force)
If force is set, directories that are git repositories will also be deleted.- Parameters:
force
- whether or not to delete git repositories- Returns:
this
- Since:
- 4.5
-
setCleanDirectories
public CleanCommand setCleanDirectories(boolean dirs)
If dirs is set, in addition to files, also clean directories.- Parameters:
dirs
- whether to clean directories too, or only files.- Returns:
this
-
setIgnore
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
- whether to respect .gitignore or not.- Returns:
this
-
-