Package org.eclipse.jgit.api

Class AddNoteCommand

java.lang.Object

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

org.eclipse.jgit.api.AddNoteCommand

All Implemented Interfaces:

Callable<Note>

public class AddNoteCommand
extends GitCommand<Note>

Add object notes.

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	AddNoteCommand(Repository repo)

Method Summary

Modifier and Type	Method	Description
Note	call()	Executes the command
AddNoteCommand	setMessage(String message)
AddNoteCommand	setNotesRef(String notesRef)
AddNoteCommand	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

AddNoteCommand

protected AddNoteCommand(Repository repo)

Parameters:

repo -

Method Detail

call

public Note call()
          throws GitAPIException

Description copied from class: GitCommand

Executes the command

Specified by:

call in interface Callable<Note>

Specified by:

call in class GitCommand<Note>

Returns:

T a result. Each command has its own return type

Throws:

GitAPIException - or subclass thereof when an error occurs

setObjectId

public AddNoteCommand setObjectId(RevObject id)

Sets the object id of object you want a note on. If the object already has a note, the existing note will be replaced.

Parameters:

id -

Returns:

this

setMessage

public AddNoteCommand setMessage(String message)

Parameters:

message - the notes message used when adding a note

Returns:

this

setNotesRef

public AddNoteCommand setNotesRef(String notesRef)

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