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

public Class ListNotesCommand

extends GitCommand<List<Note>>
Class Inheritance
Imports
java.io.IOException, java.util.ArrayList, .Iterator, .List, 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, .RevWalk

List object notes.
See Also
Git documentation about Notes

Field Summary

Modifier and TypeField and Description
private String
Inherited from org.eclipse.jgit.api.GitCommand:
repo

Constructor Summary

AccessConstructor and Description
protected
ListNotesCommand(Repository repo)

Constructor for ListNotesCommand.

Method Summary

Modifier and TypeMethod and Description
public List<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 ListNotesCommand

Returns:

this
setNotesRef
(String
the name of 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

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

Field Detail

notesRefback to summary
private String notesRef

Constructor Detail

ListNotesCommandback to summary
protected ListNotesCommand(Repository repo)

Constructor for ListNotesCommand.

Parameters
repo:Repository

the org.eclipse.jgit.lib.Repository

Method Detail

callback to summary
public List<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:List<Note>

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

computed result

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

Set the Ref to read notes from

Parameters
notesRef:String

the name of 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:ListNotesCommand

this

See Also
Constants#R_NOTES_COMMITS