org.eclipse.jgit.api

Class RemoveNoteCommand

java.lang.Object

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

org.eclipse.jgit.api.RemoveNoteCommand

All Implemented Interfaces:

Callable<Note>

public class RemoveNoteCommand
extends GitCommand<Note>

Remove 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 and Description
protected	RemoveNoteCommand(Repository repo)

Method Summary

Methods

Modifier and Type	Method and Description
Note	call() Executes the command
RemoveNoteCommand	setNotesRef(String notesRef)
RemoveNoteCommand	setObjectId(RevObject id) Sets the object id of object you want to remove a note

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

RemoveNoteCommand

protected RemoveNoteCommand(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 RemoveNoteCommand setObjectId(RevObject id)

Sets the object id of object you want to remove a note

Parameters:

id -

Returns:

this

setNotesRef

public RemoveNoteCommand 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