Package org.eclipse.jgit.api
Class RmCommand
- java.lang.Object
-
- org.eclipse.jgit.api.GitCommand<DirCache>
-
- org.eclipse.jgit.api.RmCommand
-
public class RmCommand extends GitCommand<DirCache>
Remove files from the index and working directory (or optionally only from the index).It has setters for all supported options and arguments of this command and a
call()
method to finally execute the command. Each instance of this class should only be used for one invocation of the command (means: one call tocall()
).Examples (
git
is aGit
instance):Remove file "test.txt" from both index and working directory:
git.rm().addFilepattern("test.txt").call();
Remove file "new.txt" from the index (but not from the working directory):
git.rm().setCached(true).addFilepattern("new.txt").call();
- See Also:
- Git documentation about Rm
-
-
Field Summary
-
Fields inherited from class org.eclipse.jgit.api.GitCommand
repo
-
-
Constructor Summary
Constructors Constructor Description RmCommand(Repository repo)
Constructor for RmCommand.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RmCommand
addFilepattern(String filepattern)
Add file name pattern of files to be removedDirCache
call()
RmCommand
setCached(boolean cached)
Only remove the specified files from the index.-
Methods inherited from class org.eclipse.jgit.api.GitCommand
checkCallable, getRepository, setCallable
-
-
-
-
Constructor Detail
-
RmCommand
public RmCommand(Repository repo)
Constructor for RmCommand.- Parameters:
repo
- theRepository
-
-
Method Detail
-
addFilepattern
public RmCommand addFilepattern(String filepattern)
Add file name pattern of files to be removed- Parameters:
filepattern
- repository-relative path of file to remove (with/
as separator)- Returns:
this
-
setCached
public RmCommand setCached(boolean cached)
Only remove the specified files from the index.- Parameters:
cached
-true
if files should only be removed from index,false
if files should also be deleted from the working directory- Returns:
this
- Since:
- 2.2
-
call
public DirCache call() throws GitAPIException, NoFilepatternException
Execute the command
Executes the
Rm
command. Each instance of this class should only be used for one invocation of the command. Don't call this method twice on an instance.- Specified by:
call
in interfaceCallable<DirCache>
- Specified by:
call
in classGitCommand<DirCache>
- Throws:
GitAPIException
NoFilepatternException
-
-