Package org.eclipse.jgit.api
Class RemoveNoteCommand
- java.lang.Object
-
- org.eclipse.jgit.api.GitCommand<Note>
-
- org.eclipse.jgit.api.RemoveNoteCommand
-
- All Implemented Interfaces:
java.util.concurrent.Callable<Note>
public class RemoveNoteCommand extends GitCommand<Note>
Remove object notes.- See Also:
- Git documentation about Notes
-
-
Field Summary
-
Fields inherited from class org.eclipse.jgit.api.GitCommand
repo
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
RemoveNoteCommand(Repository repo)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Note
call()
Executes the commandRemoveNoteCommand
setNotesRef(java.lang.String notesRef)
RemoveNoteCommand
setObjectId(RevObject id)
Sets the object id of object you want to remove a note-
Methods inherited from class org.eclipse.jgit.api.GitCommand
checkCallable, getRepository, setCallable
-
-
-
-
Constructor Detail
-
RemoveNoteCommand
protected RemoveNoteCommand(Repository repo)
- Parameters:
repo
-
-
-
Method Detail
-
call
public Note call() throws GitAPIException
Description copied from class:GitCommand
Executes the command- Specified by:
call
in interfacejava.util.concurrent.Callable<Note>
- Specified by:
call
in classGitCommand<Note>
- Returns:
- T a result. Each command has its own return type
- Throws:
GitAPIException
- or subclass thereof when an error occurs
-
setObjectId
public RemoveNoteCommand setObjectId(RevObject id)
Sets the object id of object you want to remove a note- Parameters:
id
-- Returns:
this
-
setNotesRef
public RemoveNoteCommand setNotesRef(java.lang.String notesRef)
- Parameters:
notesRef
- the ref to read notes from. Note, the default value ofConstants.R_NOTES_COMMITS
will be used if nothing is set- Returns:
this
- See Also:
Constants.R_NOTES_COMMITS
-
-