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
47 import org.eclipse.jgit.api.errors.GitAPIException;
48 import org.eclipse.jgit.api.errors.JGitInternalException;
49 import org.eclipse.jgit.lib.Constants;
50 import org.eclipse.jgit.lib.Ref;
51 import org.eclipse.jgit.lib.Repository;
52 import org.eclipse.jgit.notes.Note;
53 import org.eclipse.jgit.notes.NoteMap;
54 import org.eclipse.jgit.revwalk.RevCommit;
55 import org.eclipse.jgit.revwalk.RevObject;
56 import org.eclipse.jgit.revwalk.RevWalk;
57
58 /**
59 * Show an object note.
60 *
61 * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-notes.html"
62 * >Git documentation about Notes</a>
63 */
64 public class ShowNoteCommand extends GitCommand<Note> {
65
66 private RevObject id;
67
68 private String notesRef = Constants.R_NOTES_COMMITS;
69
70 /**
71 * @param repo
72 */
73 protected ShowNoteCommand(Repository repo) {
74 super(repo);
75 }
76
77 public Note call() throws GitAPIException {
78 checkCallable();
79 NoteMap map = NoteMap.newEmptyMap();
80 RevCommit notesCommit = null;
81 try (RevWalk walk = new RevWalk(repo)) {
82 Ref ref = repo.exactRef(notesRef);
83 // if we have a notes ref, use it
84 if (ref != null) {
85 notesCommit = walk.parseCommit(ref.getObjectId());
86 map = NoteMap.read(walk.getObjectReader(), notesCommit);
87 }
88 return map.getNote(id);
89 } catch (IOException e) {
90 throw new JGitInternalException(e.getMessage(), e);
91 }
92 }
93
94 /**
95 * Sets the object id of object you want a note on
96 *
97 * @param id
98 * @return {@code this}
99 */
100 public ShowNoteCommand setObjectId(RevObject id) {
101 checkCallable();
102 this.id = id;
103 return this;
104 }
105
106 /**
107 * @param notesRef
108 * the ref to read notes from. Note, the default value of
109 * {@link Constants#R_NOTES_COMMITS} will be used if nothing is
110 * set
111 * @return {@code this}
112 *
113 * @see Constants#R_NOTES_COMMITS
114 */
115 public ShowNoteCommand setNotesRef(String notesRef) {
116 checkCallable();
117 this.notesRef = notesRef;
118 return this;
119 }
120
121 }