aboutsummaryrefslogtreecommitdiffstats
path: root/org.eclipse.jgit/src/org/eclipse/jgit/api/RemoveNoteCommand.java
diff options
context:
space:
mode:
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/api/RemoveNoteCommand.java')
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/api/RemoveNoteCommand.java95
1 files changed, 22 insertions, 73 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/RemoveNoteCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/RemoveNoteCommand.java
index af09f65f17..c65cbf160f 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/api/RemoveNoteCommand.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/RemoveNoteCommand.java
@@ -1,44 +1,11 @@
/*
- * Copyright (C) 2011, Chris Aniszczyk <caniszczyk@gmail.com>
- * and other copyright owners as documented in the project's IP log.
+ * Copyright (C) 2011, Chris Aniszczyk <caniszczyk@gmail.com> and others
*
- * 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
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Distribution License v. 1.0 which is available at
+ * https://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.
+ * SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.api;
@@ -46,13 +13,9 @@ import java.io.IOException;
import org.eclipse.jgit.api.errors.GitAPIException;
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;
@@ -73,27 +36,34 @@ public class RemoveNoteCommand extends GitCommand<Note> {
private String notesRef = Constants.R_NOTES_COMMITS;
/**
+ * <p>
+ * Constructor for RemoveNoteCommand.
+ * </p>
+ *
* @param repo
+ * the {@link org.eclipse.jgit.lib.Repository}
*/
protected RemoveNoteCommand(Repository repo) {
super(repo);
}
+ @Override
public Note call() throws GitAPIException {
checkCallable();
try (RevWalk walk = new RevWalk(repo);
ObjectInserter inserter = repo.newObjectInserter()) {
NoteMap map = NoteMap.newEmptyMap();
RevCommit notesCommit = null;
- Ref ref = repo.getRef(notesRef);
+ Ref ref = repo.exactRef(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'");
+ AddNoteCommand.commitNoteMap(repo, notesRef, walk, map, notesCommit,
+ inserter,
+ "Notes removed by 'git notes remove'"); //$NON-NLS-1$
return map.getNote(id);
} catch (IOException e) {
throw new JGitInternalException(e.getMessage(), e);
@@ -104,6 +74,8 @@ public class RemoveNoteCommand extends GitCommand<Note> {
* Sets the object id of object you want to remove a note
*
* @param id
+ * the {@link org.eclipse.jgit.revwalk.RevObject} to remove a
+ * note from.
* @return {@code this}
*/
public RemoveNoteCommand setObjectId(RevObject id) {
@@ -112,37 +84,14 @@ public class RemoveNoteCommand extends GitCommand<Note> {
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);
- }
-
/**
+ * Set the name of the <code>Ref</code> to remove a note from.
+ *
* @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
+ * the {@code Ref} to read notes from. Note, the default value of
+ * {@link org.eclipse.jgit.lib.Constants#R_NOTES_COMMITS} will be
+ * used if nothing is set
* @return {@code this}
- *
* @see Constants#R_NOTES_COMMITS
*/
public RemoveNoteCommand setNotesRef(String notesRef) {