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

public Class RemoveNoteCommand

extends GitCommand<Note>
Class Inheritance
Imports
java.io.IOException, org.eclipse.jgit.api.errors.GitAPIException, .JGitInternalException, org.eclipse.jgit.lib.Constants, .ObjectInserter, .Ref, .Repository, org.eclipse.jgit.notes.Note, .NoteMap, org.eclipse.jgit.revwalk.RevCommit, .RevObject, .RevWalk
Remove object notes.
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
RemoveNoteCommand(Repository
the org.eclipse.jgit.lib.Repository
repo)

Constructor for RemoveNoteCommand.

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 RemoveNoteCommand

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 name of the Ref to remove a note from.

public RemoveNoteCommand

Returns:

this
setObjectId(RevObject
the org.eclipse.jgit.revwalk.RevObject to remove a note from.
id)

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

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

Field Detail

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

Constructor Detail

RemoveNoteCommandback to summary
protected RemoveNoteCommand(Repository repo)

Constructor for RemoveNoteCommand.

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 RemoveNoteCommand setNotesRef(String notesRef)

Set the name of the Ref to remove a note 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:RemoveNoteCommand

this

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

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

Parameters
id:RevObject

the org.eclipse.jgit.revwalk.RevObject to remove a note from.

Returns:RemoveNoteCommand

this