diff options
6 files changed, 719 insertions, 0 deletions
diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/NotesCommandTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/NotesCommandTest.java new file mode 100644 index 0000000000..cb34c0e87c --- /dev/null +++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/api/NotesCommandTest.java @@ -0,0 +1,100 @@ +/* + * Copyright (C) 2011, Chris Aniszczyk <caniszczyk@gmail.com> + * and other copyright owners as documented in the project's IP log. + * + * This program and the accompanying materials are made available + * under the terms of the Eclipse Distribution License v1.0 which + * accompanies this distribution, is reproduced below, and is + * available at http://www.eclipse.org/org/documents/edl-v10.php + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * - Neither the name of the Eclipse Foundation, Inc. nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package org.eclipse.jgit.api; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +import java.util.List; + +import org.eclipse.jgit.lib.RepositoryTestCase; +import org.eclipse.jgit.notes.Note; +import org.eclipse.jgit.revwalk.RevCommit; +import org.junit.Before; +import org.junit.Test; + +public class NotesCommandTest extends RepositoryTestCase { + + private Git git; + + private RevCommit commit1, commit2; + + private static final String FILE = "test.txt"; + + @Override + @Before + public void setUp() throws Exception { + super.setUp(); + + git = new Git(db); + // commit something + writeTrashFile(FILE, "Hello world"); + git.add().addFilepattern(FILE).call(); + commit1 = git.commit().setMessage("Initial commit").call(); + git.rm().addFilepattern(FILE).call(); + commit2 = git.commit().setMessage("Removed file").call(); + git.notesAdd().setObjectId(commit1) + .setMessage("data").call(); + } + + @Test + public void testListNotes() throws Exception { + List<Note> notes = git.notesList().call(); + assertTrue(notes.size() == 1); + } + + @Test + public void testAddAndRemoveNote() throws Exception { + git.notesAdd().setObjectId(commit2).setMessage("data").call(); + Note note = git.notesShow().setObjectId(commit2).call(); + String content = new String(db.open(note.getData()).getCachedBytes(), + "UTF-8"); + assertEquals(content, "data"); + + git.notesRemove().setObjectId(commit2).call(); + + List<Note> notes = git.notesList().call(); + assertTrue(notes.size() == 1); + } + +} diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/AddNoteCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/AddNoteCommand.java new file mode 100644 index 0000000000..d1c75e2ca1 --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/AddNoteCommand.java @@ -0,0 +1,175 @@ +/* + * Copyright (C) 2011, Chris Aniszczyk <caniszczyk@gmail.com> + * and other copyright owners as documented in the project's IP log. + * + * This program and the accompanying materials are made available + * under the terms of the Eclipse Distribution License v1.0 which + * accompanies this distribution, is reproduced below, and is + * available at http://www.eclipse.org/org/documents/edl-v10.php + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * - Neither the name of the Eclipse Foundation, Inc. nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package org.eclipse.jgit.api; + +import java.io.IOException; + +import org.eclipse.jgit.api.errors.JGitInternalException; +import org.eclipse.jgit.lib.CommitBuilder; +import org.eclipse.jgit.lib.Constants; +import org.eclipse.jgit.lib.ObjectId; +import org.eclipse.jgit.lib.ObjectInserter; +import org.eclipse.jgit.lib.PersonIdent; +import org.eclipse.jgit.lib.Ref; +import org.eclipse.jgit.lib.RefUpdate; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.notes.Note; +import org.eclipse.jgit.notes.NoteMap; +import org.eclipse.jgit.revwalk.RevCommit; +import org.eclipse.jgit.revwalk.RevObject; +import org.eclipse.jgit.revwalk.RevWalk; + +/** + * Add object notes. + * + * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-notes.html" + * >Git documentation about Notes</a> + */ +public class AddNoteCommand extends GitCommand<Note> { + + private RevObject id; + + private String message; + + private String notesRef = Constants.R_NOTES_COMMITS; + + /** + * @param repo + */ + protected AddNoteCommand(Repository repo) { + super(repo); + } + + /** + * @throws JGitInternalException + * upon internal failure + */ + public Note call() throws JGitInternalException { + checkCallable(); + RevWalk walk = new RevWalk(repo); + ObjectInserter inserter = repo.newObjectInserter(); + NoteMap map = NoteMap.newEmptyMap(); + RevCommit notesCommit = null; + try { + Ref ref = repo.getRef(notesRef); + // if we have a notes ref, use it + if (ref != null) { + notesCommit = walk.parseCommit(ref.getObjectId()); + map = NoteMap.read(walk.getObjectReader(), notesCommit); + } + map.set(id, message, inserter); + commitNoteMap(walk, map, notesCommit, inserter, + "Notes added by 'git notes add'"); + return map.getNote(id); + } catch (IOException e) { + throw new JGitInternalException(e.getMessage(), e); + } finally { + inserter.release(); + walk.release(); + } + } + + /** + * Sets the object id of object you want a note on. If the object already + * has a note, the existing note will be replaced. + * + * @param id + * @return {@code this} + */ + public AddNoteCommand setObjectId(RevObject id) { + checkCallable(); + this.id = id; + return this; + } + + /** + * @param message + * the notes message used when adding a note + * @return {@code this} + */ + public AddNoteCommand setMessage(String message) { + checkCallable(); + this.message = message; + return this; + } + + private void commitNoteMap(RevWalk walk, NoteMap map, + RevCommit notesCommit, + ObjectInserter inserter, + String msg) + throws IOException { + // commit the note + CommitBuilder builder = new CommitBuilder(); + builder.setTreeId(map.writeTree(inserter)); + builder.setAuthor(new PersonIdent(repo)); + builder.setCommitter(builder.getAuthor()); + builder.setMessage(msg); + if (notesCommit != null) + builder.setParentIds(notesCommit); + ObjectId commit = inserter.insert(builder); + inserter.flush(); + RefUpdate refUpdate = repo.updateRef(notesRef); + if (notesCommit != null) + refUpdate.setExpectedOldObjectId(notesCommit); + else + refUpdate.setExpectedOldObjectId(ObjectId.zeroId()); + refUpdate.setNewObjectId(commit); + refUpdate.update(walk); + } + + /** + * @param notesRef + * the ref to read notes from. Note, the default value of + * {@link Constants#R_NOTES_COMMITS} will be used if nothing is + * set + * @return {@code this} + * + * @see Constants#R_NOTES_COMMITS + */ + public AddNoteCommand setNotesRef(String notesRef) { + checkCallable(); + this.notesRef = notesRef; + return this; + } + +} diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java index 19f140be26..4d608a7a5c 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/Git.java @@ -394,6 +394,42 @@ public class Git { } /** + * Returns a command to add notes to an object + * + * @return a {@link AddNoteCommand} + */ + public AddNoteCommand notesAdd() { + return new AddNoteCommand(repo); + } + + /** + * Returns a command to remove notes on an object + * + * @return a {@link RemoveNoteCommand} + */ + public RemoveNoteCommand notesRemove() { + return new RemoveNoteCommand(repo); + } + + /** + * Returns a command to list all notes + * + * @return a {@link ListNotesCommand} + */ + public ListNotesCommand notesList() { + return new ListNotesCommand(repo); + } + + /** + * Returns a command to show notes on an object + * + * @return a {@link ShowNoteCommand} + */ + public ShowNoteCommand notesShow() { + return new ShowNoteCommand(repo); + } + + /** * @return the git repository this class is interacting with */ public Repository getRepository() { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/ListNotesCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/ListNotesCommand.java new file mode 100644 index 0000000000..92f883a02e --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/ListNotesCommand.java @@ -0,0 +1,120 @@ +/* + * Copyright (C) 2011, Chris Aniszczyk <caniszczyk@gmail.com> + * and other copyright owners as documented in the project's IP log. + * + * This program and the accompanying materials are made available + * under the terms of the Eclipse Distribution License v1.0 which + * accompanies this distribution, is reproduced below, and is + * available at http://www.eclipse.org/org/documents/edl-v10.php + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * - Neither the name of the Eclipse Foundation, Inc. nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package org.eclipse.jgit.api; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +import org.eclipse.jgit.api.errors.JGitInternalException; +import org.eclipse.jgit.lib.Constants; +import org.eclipse.jgit.lib.Ref; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.notes.Note; +import org.eclipse.jgit.notes.NoteMap; +import org.eclipse.jgit.revwalk.RevCommit; +import org.eclipse.jgit.revwalk.RevWalk; + +/** + * List object notes. + * + * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-notes.html" + * >Git documentation about Notes</a> + */ +public class ListNotesCommand extends GitCommand<List<Note>> { + + private String notesRef = Constants.R_NOTES_COMMITS; + + /** + * @param repo + */ + protected ListNotesCommand(Repository repo) { + super(repo); + } + + /** + * @throws JGitInternalException + * upon internal failure + */ + public List<Note> call() throws JGitInternalException { + checkCallable(); + List<Note> notes = new ArrayList<Note>(); + RevWalk walk = new RevWalk(repo); + NoteMap map = NoteMap.newEmptyMap(); + try { + Ref ref = repo.getRef(notesRef); + // if we have a notes ref, use it + if (ref != null) { + RevCommit notesCommit = walk.parseCommit(ref.getObjectId()); + map = NoteMap.read(walk.getObjectReader(), notesCommit); + } + + Iterator<Note> i = map.iterator(); + while (i.hasNext()) + notes.add(i.next()); + } catch (IOException e) { + throw new JGitInternalException(e.getMessage(), e); + } finally { + walk.release(); + } + + return notes; + } + + /** + * @param notesRef + * the ref to read notes from. Note, the default value of + * {@link Constants#R_NOTES_COMMITS} will be used if nothing is + * set + * @return {@code this} + * + * @see Constants#R_NOTES_COMMITS + */ + public ListNotesCommand setNotesRef(String notesRef) { + checkCallable(); + this.notesRef = notesRef; + return this; + } + +} diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/RemoveNoteCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/RemoveNoteCommand.java new file mode 100644 index 0000000000..5b9075e436 --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/RemoveNoteCommand.java @@ -0,0 +1,161 @@ +/* + * Copyright (C) 2011, Chris Aniszczyk <caniszczyk@gmail.com> + * and other copyright owners as documented in the project's IP log. + * + * This program and the accompanying materials are made available + * under the terms of the Eclipse Distribution License v1.0 which + * accompanies this distribution, is reproduced below, and is + * available at http://www.eclipse.org/org/documents/edl-v10.php + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * - Neither the name of the Eclipse Foundation, Inc. nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package org.eclipse.jgit.api; + +import java.io.IOException; + +import org.eclipse.jgit.api.errors.JGitInternalException; +import org.eclipse.jgit.lib.CommitBuilder; +import org.eclipse.jgit.lib.Constants; +import org.eclipse.jgit.lib.ObjectId; +import org.eclipse.jgit.lib.ObjectInserter; +import org.eclipse.jgit.lib.PersonIdent; +import org.eclipse.jgit.lib.Ref; +import org.eclipse.jgit.lib.RefUpdate; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.notes.Note; +import org.eclipse.jgit.notes.NoteMap; +import org.eclipse.jgit.revwalk.RevCommit; +import org.eclipse.jgit.revwalk.RevObject; +import org.eclipse.jgit.revwalk.RevWalk; + +/** + * Remove object notes. + * + * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-notes.html" + * >Git documentation about Notes</a> + */ +public class RemoveNoteCommand extends GitCommand<Note> { + + private RevObject id; + + private String notesRef = Constants.R_NOTES_COMMITS; + + /** + * @param repo + */ + protected RemoveNoteCommand(Repository repo) { + super(repo); + } + + /** + * @throws JGitInternalException + * upon internal failure + */ + public Note call() throws JGitInternalException { + checkCallable(); + RevWalk walk = new RevWalk(repo); + ObjectInserter inserter = repo.newObjectInserter(); + NoteMap map = NoteMap.newEmptyMap(); + RevCommit notesCommit = null; + try { + Ref ref = repo.getRef(notesRef); + // if we have a notes ref, use it + if (ref != null) { + notesCommit = walk.parseCommit(ref.getObjectId()); + map = NoteMap.read(walk.getObjectReader(), notesCommit); + } + map.set(id, null, inserter); + commitNoteMap(walk, map, notesCommit, inserter, + "Notes removed by 'git notes remove'"); + return map.getNote(id); + } catch (IOException e) { + throw new JGitInternalException(e.getMessage(), e); + } finally { + inserter.release(); + walk.release(); + } + } + + /** + * Sets the object id of object you want to remove a note + * + * @param id + * @return {@code this} + */ + public RemoveNoteCommand setObjectId(RevObject id) { + checkCallable(); + this.id = id; + return this; + } + + private void commitNoteMap(RevWalk walk, NoteMap map, + RevCommit notesCommit, + ObjectInserter inserter, + String msg) + throws IOException { + // commit the note + CommitBuilder builder = new CommitBuilder(); + builder.setTreeId(map.writeTree(inserter)); + builder.setAuthor(new PersonIdent(repo)); + builder.setCommitter(builder.getAuthor()); + builder.setMessage(msg); + if (notesCommit != null) + builder.setParentIds(notesCommit); + ObjectId commit = inserter.insert(builder); + inserter.flush(); + RefUpdate refUpdate = repo.updateRef(notesRef); + if (notesCommit != null) + refUpdate.setExpectedOldObjectId(notesCommit); + else + refUpdate.setExpectedOldObjectId(ObjectId.zeroId()); + refUpdate.setNewObjectId(commit); + refUpdate.update(walk); + } + + /** + * @param notesRef + * the ref to read notes from. Note, the default value of + * {@link Constants#R_NOTES_COMMITS} will be used if nothing is + * set + * @return {@code this} + * + * @see Constants#R_NOTES_COMMITS + */ + public RemoveNoteCommand setNotesRef(String notesRef) { + checkCallable(); + this.notesRef = notesRef; + return this; + } + +} diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/ShowNoteCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/ShowNoteCommand.java new file mode 100644 index 0000000000..45f53e7fae --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/ShowNoteCommand.java @@ -0,0 +1,127 @@ +/* + * Copyright (C) 2011, Chris Aniszczyk <caniszczyk@gmail.com> + * and other copyright owners as documented in the project's IP log. + * + * This program and the accompanying materials are made available + * under the terms of the Eclipse Distribution License v1.0 which + * accompanies this distribution, is reproduced below, and is + * available at http://www.eclipse.org/org/documents/edl-v10.php + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * - Neither the name of the Eclipse Foundation, Inc. nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package org.eclipse.jgit.api; + +import java.io.IOException; + +import org.eclipse.jgit.api.errors.JGitInternalException; +import org.eclipse.jgit.lib.Constants; +import org.eclipse.jgit.lib.Ref; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.notes.Note; +import org.eclipse.jgit.notes.NoteMap; +import org.eclipse.jgit.revwalk.RevCommit; +import org.eclipse.jgit.revwalk.RevObject; +import org.eclipse.jgit.revwalk.RevWalk; + +/** + * Show an object note. + * + * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-notes.html" + * >Git documentation about Notes</a> + */ +public class ShowNoteCommand extends GitCommand<Note> { + + private RevObject id; + + private String notesRef = Constants.R_NOTES_COMMITS; + + /** + * @param repo + */ + protected ShowNoteCommand(Repository repo) { + super(repo); + } + + /** + * @throws JGitInternalException + * upon internal failure + */ + public Note call() throws JGitInternalException { + checkCallable(); + RevWalk walk = new RevWalk(repo); + NoteMap map = NoteMap.newEmptyMap(); + RevCommit notesCommit = null; + try { + Ref ref = repo.getRef(notesRef); + // if we have a notes ref, use it + if (ref != null) { + notesCommit = walk.parseCommit(ref.getObjectId()); + map = NoteMap.read(walk.getObjectReader(), notesCommit); + } + return map.getNote(id); + } catch (IOException e) { + throw new JGitInternalException(e.getMessage(), e); + } finally { + walk.release(); + } + } + + /** + * Sets the object id of object you want a note on + * + * @param id + * @return {@code this} + */ + public ShowNoteCommand setObjectId(RevObject id) { + checkCallable(); + this.id = id; + return this; + } + + /** + * @param notesRef + * the ref to read notes from. Note, the default value of + * {@link Constants#R_NOTES_COMMITS} will be used if nothing is + * set + * @return {@code this} + * + * @see Constants#R_NOTES_COMMITS + */ + public ShowNoteCommand setNotesRef(String notesRef) { + checkCallable(); + this.notesRef = notesRef; + return this; + } + +} |