Package org.eclipse.jgit.api
Class ShowNoteCommand
- java.lang.Object
-
- org.eclipse.jgit.api.GitCommand<Note>
-
- org.eclipse.jgit.api.ShowNoteCommand
-
public class ShowNoteCommand extends GitCommand<Note>
Show an object note.- 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
ShowNoteCommand(Repository repo)
Constructor for ShowNoteCommand.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Note
call()
ShowNoteCommand
setNotesRef(String notesRef)
Set theRef
to read notes from.ShowNoteCommand
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
-
ShowNoteCommand
protected ShowNoteCommand(Repository repo)
Constructor for ShowNoteCommand.- 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 ShowNoteCommand setObjectId(RevObject id)
Sets the object id of object you want a note on- Parameters:
id
- theRevObject
to show notes for.- Returns:
this
-
setNotesRef
public ShowNoteCommand setNotesRef(String notesRef)
Set theRef
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
-
-