Package org.eclipse.jgit.api

Class ShowNoteCommand

java.lang.Object

org.eclipse.jgit.api.GitCommand<Note>

org.eclipse.jgit.api.ShowNoteCommand

All Implemented Interfaces:

Callable<Note>

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

Modifier and Type	Method	Description
Note	call()
ShowNoteCommand	setNotesRef(String notesRef)	Set the Ref 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShowNoteCommand

protected ShowNoteCommand(Repository repo)

Constructor for ShowNoteCommand.

Parameters:

repo - the Repository

Method Detail

call

public Note call()
          throws GitAPIException

Execute the command

Specified by:

call in interface Callable<Note>

Specified by:

call in class GitCommand<Note>

Throws:

GitAPIException

setObjectId

public ShowNoteCommand setObjectId(RevObject id)

Sets the object id of object you want a note on

Parameters:

id - the RevObject to show notes for.

Returns:

this

setNotesRef

public ShowNoteCommand setNotesRef(String notesRef)

Set the Ref to read notes from.

Parameters:

notesRef - the ref to read notes from. Note, the default value of Constants.R_NOTES_COMMITS will be used if nothing is set

Returns:

this

See Also:

Constants.R_NOTES_COMMITS