You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

RemoveNoteCommand.java 5.0KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  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. import java.io.IOException;
  45. import org.eclipse.jgit.api.errors.GitAPIException;
  46. import org.eclipse.jgit.api.errors.JGitInternalException;
  47. import org.eclipse.jgit.lib.CommitBuilder;
  48. import org.eclipse.jgit.lib.Constants;
  49. import org.eclipse.jgit.lib.ObjectId;
  50. import org.eclipse.jgit.lib.ObjectInserter;
  51. import org.eclipse.jgit.lib.PersonIdent;
  52. import org.eclipse.jgit.lib.Ref;
  53. import org.eclipse.jgit.lib.RefUpdate;
  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.RevObject;
  59. import org.eclipse.jgit.revwalk.RevWalk;
  60. /**
  61. * Remove 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 RemoveNoteCommand extends GitCommand<Note> {
  67. private RevObject id;
  68. private String notesRef = Constants.R_NOTES_COMMITS;
  69. /**
  70. * @param repo
  71. */
  72. protected RemoveNoteCommand(Repository repo) {
  73. super(repo);
  74. }
  75. public Note call() throws GitAPIException {
  76. checkCallable();
  77. try (RevWalk walk = new RevWalk(repo);
  78. ObjectInserter inserter = repo.newObjectInserter()) {
  79. NoteMap map = NoteMap.newEmptyMap();
  80. RevCommit notesCommit = null;
  81. Ref ref = repo.exactRef(notesRef);
  82. // if we have a notes ref, use it
  83. if (ref != null) {
  84. notesCommit = walk.parseCommit(ref.getObjectId());
  85. map = NoteMap.read(walk.getObjectReader(), notesCommit);
  86. }
  87. map.set(id, null, inserter);
  88. commitNoteMap(walk, map, notesCommit, inserter,
  89. "Notes removed by 'git notes remove'"); //$NON-NLS-1$
  90. return map.getNote(id);
  91. } catch (IOException e) {
  92. throw new JGitInternalException(e.getMessage(), e);
  93. }
  94. }
  95. /**
  96. * Sets the object id of object you want to remove a note
  97. *
  98. * @param id
  99. * @return {@code this}
  100. */
  101. public RemoveNoteCommand setObjectId(RevObject id) {
  102. checkCallable();
  103. this.id = id;
  104. return this;
  105. }
  106. private void commitNoteMap(RevWalk walk, NoteMap map,
  107. RevCommit notesCommit,
  108. ObjectInserter inserter,
  109. String msg)
  110. throws IOException {
  111. // commit the note
  112. CommitBuilder builder = new CommitBuilder();
  113. builder.setTreeId(map.writeTree(inserter));
  114. builder.setAuthor(new PersonIdent(repo));
  115. builder.setCommitter(builder.getAuthor());
  116. builder.setMessage(msg);
  117. if (notesCommit != null)
  118. builder.setParentIds(notesCommit);
  119. ObjectId commit = inserter.insert(builder);
  120. inserter.flush();
  121. RefUpdate refUpdate = repo.updateRef(notesRef);
  122. if (notesCommit != null)
  123. refUpdate.setExpectedOldObjectId(notesCommit);
  124. else
  125. refUpdate.setExpectedOldObjectId(ObjectId.zeroId());
  126. refUpdate.setNewObjectId(commit);
  127. refUpdate.update(walk);
  128. }
  129. /**
  130. * @param notesRef
  131. * the ref to read notes from. Note, the default value of
  132. * {@link Constants#R_NOTES_COMMITS} will be used if nothing is
  133. * set
  134. * @return {@code this}
  135. *
  136. * @see Constants#R_NOTES_COMMITS
  137. */
  138. public RemoveNoteCommand setNotesRef(String notesRef) {
  139. checkCallable();
  140. this.notesRef = notesRef;
  141. return this;
  142. }
  143. }