public class RmCommand extends GitCommand<DirCache>
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
to call()
).
Examples (git
is a Git
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();
Modifier and Type | Field and Description |
---|---|
private boolean |
cached
Only remove files from index, not from working directory
|
private java.util.Collection<java.lang.String> |
filepatterns |
repo
Constructor and Description |
---|
RmCommand(Repository repo)
Constructor for RmCommand.
|
Modifier and Type | Method and Description |
---|---|
RmCommand |
addFilepattern(java.lang.String filepattern)
Add file name pattern of files to be removed
|
DirCache |
call() |
private boolean |
delete(java.io.File p) |
RmCommand |
setCached(boolean cached)
Only remove the specified files from the index.
|
checkCallable, getRepository, setCallable
private java.util.Collection<java.lang.String> filepatterns
private boolean cached
public RmCommand(Repository repo)
repo
- the Repository
public RmCommand addFilepattern(java.lang.String filepattern)
filepattern
- repository-relative path of file to remove (with
/
as separator)this
public RmCommand setCached(boolean cached)
cached
- true
if files should only be removed from index,
false
if files should also be deleted from the working
directorythis
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.
call
in interface java.util.concurrent.Callable<DirCache>
call
in class GitCommand<DirCache>
GitAPIException
NoFilepatternException
private boolean delete(java.io.File p)