Top Description Fields Constructors Methods
org.eclipse.jgit.api

public Class ShowNoteCommand

extends GitCommand<Note>
Class Inheritance
Imports
java.io.IOException, org.eclipse.jgit.api.errors.GitAPIException, .JGitInternalException, org.eclipse.jgit.lib.Constants, .Ref, .Repository, org.eclipse.jgit.notes.Note, .NoteMap, org.eclipse.jgit.revwalk.RevCommit, .RevObject, .RevWalk
Show an object note.
See Also
Git documentation about Notes

Field Summary

Modifier and TypeField and Description
private RevObject
id

private String
notesRef

Inherited from org.eclipse.jgit.api.GitCommand:
repo

Constructor Summary

AccessConstructor and Description
protected
ShowNoteCommand(Repository
the org.eclipse.jgit.lib.Repository
repo)

Constructor for ShowNoteCommand.

Method Summary

Modifier and TypeMethod and Description
public Note
call()

Implements abstract org.eclipse.jgit.api.GitCommand.call.

Implements java.util.concurrent.Callable.call.

Computes a result, or throws an exception if unable to do so.

public ShowNoteCommand

Returns:

this
setNotesRef(String
the ref to read notes from. Note, the default value of org.eclipse.jgit.lib.Constants#R_NOTES_COMMITS will be used if nothing is set
notesRef)

Set the Ref to read notes from.

public ShowNoteCommand

Returns:

this
setObjectId(RevObject
the org.eclipse.jgit.revwalk.RevObject to show notes for.
id)

Sets the object id of object you want a note on

Inherited from org.eclipse.jgit.api.GitCommand:
checkCallablegetRepositorysetCallable

Field Detail

idback to summary
private RevObject id
notesRefback to summary
private String notesRef

Constructor Detail

ShowNoteCommandback to summary
protected ShowNoteCommand(Repository repo)

Constructor for ShowNoteCommand.

Parameters
repo:Repository

the org.eclipse.jgit.lib.Repository

Method Detail

callback to summary
public Note call() throws GitAPIException

Implements abstract org.eclipse.jgit.api.GitCommand.call.

Implements java.util.concurrent.Callable.call.

Doc from org.eclipse.jgit.api.GitCommand.call.

Computes a result, or throws an exception if unable to do so.

Execute the command

Returns:Note

Doc from java.util.concurrent.Callable.call.

computed result

Annotations
@Override
setNotesRefback to summary
public ShowNoteCommand setNotesRef(String notesRef)

Set the Ref to read notes from.

Parameters
notesRef:String

the ref to read notes from. Note, the default value of org.eclipse.jgit.lib.Constants#R_NOTES_COMMITS will be used if nothing is set

Returns:ShowNoteCommand

this

See Also
Constants#R_NOTES_COMMITS
setObjectIdback to summary
public ShowNoteCommand setObjectId(RevObject id)

Sets the object id of object you want a note on

Parameters
id:RevObject

the org.eclipse.jgit.revwalk.RevObject to show notes for.

Returns:ShowNoteCommand

this