1 /* 2 * Copyright (C) 2011, Chris Aniszczyk <caniszczyk@gmail.com> 3 * and other copyright owners as documented in the project's IP log. 4 * 5 * This program and the accompanying materials are made available 6 * under the terms of the Eclipse Distribution License v1.0 which 7 * accompanies this distribution, is reproduced below, and is 8 * available at http://www.eclipse.org/org/documents/edl-v10.php 9 * 10 * All rights reserved. 11 * 12 * Redistribution and use in source and binary forms, with or 13 * without modification, are permitted provided that the following 14 * conditions are met: 15 * 16 * - Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 19 * - Redistributions in binary form must reproduce the above 20 * copyright notice, this list of conditions and the following 21 * disclaimer in the documentation and/or other materials provided 22 * with the distribution. 23 * 24 * - Neither the name of the Eclipse Foundation, Inc. nor the 25 * names of its contributors may be used to endorse or promote 26 * products derived from this software without specific prior 27 * written permission. 28 * 29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 42 */ 43 package org.eclipse.jgit.api; 44 45 import java.io.IOException; 46 import java.util.ArrayList; 47 import java.util.Iterator; 48 import java.util.List; 49 50 import org.eclipse.jgit.api.errors.GitAPIException; 51 import org.eclipse.jgit.api.errors.JGitInternalException; 52 import org.eclipse.jgit.lib.Constants; 53 import org.eclipse.jgit.lib.Ref; 54 import org.eclipse.jgit.lib.Repository; 55 import org.eclipse.jgit.notes.Note; 56 import org.eclipse.jgit.notes.NoteMap; 57 import org.eclipse.jgit.revwalk.RevCommit; 58 import org.eclipse.jgit.revwalk.RevWalk; 59 60 /** 61 * List object notes. 62 * 63 * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-notes.html" 64 * >Git documentation about Notes</a> 65 */ 66 public class ListNotesCommand extends GitCommand<List<Note>> { 67 68 private String notesRef = Constants.R_NOTES_COMMITS; 69 70 /** 71 * @param repo 72 */ 73 protected ListNotesCommand(Repository repo) { 74 super(repo); 75 } 76 77 /** 78 * @return the requested notes 79 */ 80 public List<Note> call() throws GitAPIException { 81 checkCallable(); 82 List<Note> notes = new ArrayList<Note>(); 83 NoteMap map = NoteMap.newEmptyMap(); 84 try (RevWalk walk = new RevWalk(repo)) { 85 Ref ref = repo.getRef(notesRef); 86 // if we have a notes ref, use it 87 if (ref != null) { 88 RevCommit notesCommit = walk.parseCommit(ref.getObjectId()); 89 map = NoteMap.read(walk.getObjectReader(), notesCommit); 90 } 91 92 Iterator<Note> i = map.iterator(); 93 while (i.hasNext()) 94 notes.add(i.next()); 95 } catch (IOException e) { 96 throw new JGitInternalException(e.getMessage(), e); 97 } 98 99 return notes; 100 } 101 102 /** 103 * @param notesRef 104 * the ref to read notes from. Note, the default value of 105 * {@link Constants#R_NOTES_COMMITS} will be used if nothing is 106 * set 107 * @return {@code this} 108 * 109 * @see Constants#R_NOTES_COMMITS 110 */ 111 public ListNotesCommand setNotesRef(String notesRef) { 112 checkCallable(); 113 this.notesRef = notesRef; 114 return this; 115 } 116 117 }