Package org.eclipse.jgit.api
Class AddNoteCommand
- java.lang.Object
-
- org.eclipse.jgit.api.GitCommand<Note>
-
- org.eclipse.jgit.api.AddNoteCommand
-
public class AddNoteCommand extends GitCommand<Note>
Add 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
AddNoteCommand(Repository repo)
Constructor for AddNoteCommand
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Note
call()
AddNoteCommand
setMessage(String message)
Set the notes messageAddNoteCommand
setNotesRef(String notesRef)
Set name of aRef
to read notes fromAddNoteCommand
setObjectId(RevObject id)
Sets the object id of object you want a note on.-
Methods inherited from class org.eclipse.jgit.api.GitCommand
checkCallable, getRepository, setCallable
-
-
-
-
Constructor Detail
-
AddNoteCommand
protected AddNoteCommand(Repository repo)
Constructor for AddNoteCommand- Parameters:
repo
- theRepository
-
-
Method Detail
-
call
public Note call() throws GitAPIException
Execute the command
- Specified by:
call
in interfaceCallable<Note>
- Specified by:
call
in classGitCommand<Note>
- Throws:
GitAPIException
-
setObjectId
public AddNoteCommand setObjectId(RevObject id)
Sets the object id of object you want a note on. If the object already has a note, the existing note will be replaced.- Parameters:
id
- aRevObject
- Returns:
this
-
setMessage
public AddNoteCommand setMessage(String message)
Set the notes message- Parameters:
message
- the notes message used when adding a note- Returns:
this
-
setNotesRef
public AddNoteCommand setNotesRef(String notesRef)
Set name of aRef
to read notes from- 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
-
-