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)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Note
call()
Executes the commandShowNoteCommand
setNotesRef(String notesRef)
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)
- Parameters:
repo
-
-
-
Method Detail
-
call
public Note call() throws GitAPIException
Description copied from class:GitCommand
Executes the command- Specified by:
call
in interfaceCallable<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 ShowNoteCommand setObjectId(RevObject id)
Sets the object id of object you want a note on- Parameters:
id
-- Returns:
this
-
setNotesRef
public ShowNoteCommand setNotesRef(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
-
-