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.ObjectInserter;
51 import org.eclipse.jgit.lib.Ref;
52 import org.eclipse.jgit.lib.Repository;
53 import org.eclipse.jgit.notes.Note;
54 import org.eclipse.jgit.notes.NoteMap;
55 import org.eclipse.jgit.revwalk.RevCommit;
56 import org.eclipse.jgit.revwalk.RevObject;
57 import org.eclipse.jgit.revwalk.RevWalk;
58
59 /**
60 * Remove object notes.
61 *
62 * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-notes.html"
63 * >Git documentation about Notes</a>
64 */
65 public class RemoveNoteCommand extends GitCommand<Note> {
66
67 private RevObject id;
68
69 private String notesRef = Constants.R_NOTES_COMMITS;
70
71 /**
72 * <p>
73 * Constructor for RemoveNoteCommand.
74 * </p>
75 *
76 * @param repo
77 * the {@link org.eclipse.jgit.lib.Repository}
78 */
79 protected RemoveNoteCommand(Repository repo) {
80 super(repo);
81 }
82
83 /** {@inheritDoc} */
84 @Override
85 public Note call() throws GitAPIException {
86 checkCallable();
87 try (RevWalkvWalk.html#RevWalk">RevWalk walk = new RevWalk(repo);
88 ObjectInserter inserter = repo.newObjectInserter()) {
89 NoteMap map = NoteMap.newEmptyMap();
90 RevCommit notesCommit = null;
91 Ref ref = repo.exactRef(notesRef);
92 // if we have a notes ref, use it
93 if (ref != null) {
94 notesCommit = walk.parseCommit(ref.getObjectId());
95 map = NoteMap.read(walk.getObjectReader(), notesCommit);
96 }
97 map.set(id, null, inserter);
98 AddNoteCommand.commitNoteMap(repo, notesRef, walk, map, notesCommit,
99 inserter,
100 "Notes removed by 'git notes remove'"); //$NON-NLS-1$
101 return map.getNote(id);
102 } catch (IOException e) {
103 throw new JGitInternalException(e.getMessage(), e);
104 }
105 }
106
107 /**
108 * Sets the object id of object you want to remove a note
109 *
110 * @param id
111 * the {@link org.eclipse.jgit.revwalk.RevObject} to remove a
112 * note from.
113 * @return {@code this}
114 */
115 public RemoveNoteCommand setObjectId(RevObject id) {
116 checkCallable();
117 this.id = id;
118 return this;
119 }
120
121 /**
122 * Set the name of the <code>Ref</code> to remove a note from.
123 *
124 * @param notesRef
125 * the {@code Ref} to read notes from. Note, the default value of
126 * {@link org.eclipse.jgit.lib.Constants#R_NOTES_COMMITS} will be
127 * used if nothing is set
128 * @return {@code this}
129 * @see Constants#R_NOTES_COMMITS
130 */
131 public RemoveNoteCommand setNotesRef(String notesRef) {
132 checkCallable();
133 this.notesRef = notesRef;
134 return this;
135 }
136
137 }