123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271 |
- /*
- * Copyright (C) 2006-2008, Robin Rosenberg <robin.rosenberg@dewire.com>
- * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
- * Copyright (C) 2010, Chris Aniszczyk <caniszczyk@gmail.com>
- * and other copyright owners as documented in the project's IP log.
- *
- * 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
- *
- * 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.
- */
-
- package org.eclipse.jgit.lib;
-
- import java.io.ByteArrayOutputStream;
- import java.io.IOException;
- import java.io.OutputStreamWriter;
-
- import org.eclipse.jgit.revwalk.RevObject;
-
- /**
- * Mutable builder to construct an annotated tag recording a project state.
- *
- * Applications should use this object when they need to manually construct a
- * tag and want precise control over its fields.
- *
- * To read a tag object, construct a {@link org.eclipse.jgit.revwalk.RevWalk}
- * and obtain a {@link org.eclipse.jgit.revwalk.RevTag} instance by calling
- * {@link org.eclipse.jgit.revwalk.RevWalk#parseTag(AnyObjectId)}.
- */
- public class TagBuilder {
- private ObjectId tagId;
-
- private ObjectId object;
-
- private int type = Constants.OBJ_BAD;
-
- private String tag;
-
- private PersonIdent tagger;
-
- private String message;
-
- /** @return this tag's object id. */
- public ObjectId getTagId() {
- return tagId;
- }
-
- /**
- * Set the id of this tag object.
- *
- * @param id
- * the id that we calculated for this object.
- */
- public void setTagId(ObjectId id) {
- tagId = id;
- }
-
- /** @return the type of object this tag refers to. */
- public int getObjectType() {
- return type;
- }
-
- /** @return the object this tag refers to. */
- public ObjectId getObjectId() {
- return object;
- }
-
- /**
- * Set the object this tag refers to, and its type.
- *
- * @param obj
- * the object.
- * @param objType
- * the type of {@code obj}. Must be a valid type code.
- */
- public void setObjectId(AnyObjectId obj, int objType) {
- object = obj.copy();
- type = objType;
- tagId = null;
- }
-
- /**
- * Set the object this tag refers to, and infer its type.
- *
- * @param obj
- * the object the tag will refer to.
- */
- public void setObjectId(RevObject obj) {
- setObjectId(obj, obj.getType());
- }
-
- /** @return short name of the tag (no {@code refs/tags/} prefix). */
- public String getTag() {
- return tag;
- }
-
- /**
- * Set the name of this tag.
- *
- * @param shortName
- * new short name of the tag. This short name should not start
- * with {@code refs/} as typically a tag is stored under the
- * reference derived from {@code "refs/tags/" + getTag()}.
- */
- public void setTag(String shortName) {
- this.tag = shortName;
- tagId = null;
- }
-
- /** @return creator of this tag. May be null. */
- public PersonIdent getTagger() {
- return tagger;
- }
-
- /**
- * Set the creator of this tag.
- *
- * @param taggerIdent
- * the creator. May be null.
- */
- public void setTagger(PersonIdent taggerIdent) {
- tagger = taggerIdent;
- tagId = null;
- }
-
- /** @return the complete commit message. */
- public String getMessage() {
- return message;
- }
-
- /**
- * Set the tag's message.
- *
- * @param newMessage
- * the tag's message.
- */
- public void setMessage(final String newMessage) {
- message = newMessage;
- tagId = null;
- }
-
- /**
- * Format this builder's state as an annotated tag object.
- *
- * As a side effect, {@link #getTagId()} will be populated with the proper
- * ObjectId for the formatted content.
- *
- * @return this object in the canonical annotated tag format, suitable for
- * storage in a repository.
- */
- public byte[] format() {
- return format(new ObjectInserter.Formatter());
- }
-
- /**
- * Format this builder's state as an annotated tag object.
- *
- * As a side effect, {@link #getTagId()} will be populated with the proper
- * ObjectId for the formatted content.
- *
- * @param oi
- * the inserter whose formatting support will be reused. The
- * inserter itself is not affected, and the annotated tag is not
- * actually inserted into the repository.
- * @return this object in the canonical annotated tag format, suitable for
- * storage in a repository.
- */
- public byte[] format(ObjectInserter oi) {
- ByteArrayOutputStream os = new ByteArrayOutputStream();
- OutputStreamWriter w = new OutputStreamWriter(os, Constants.CHARSET);
- try {
- w.write("object ");
- getObjectId().copyTo(w);
- w.write('\n');
-
- w.write("type ");
- w.write(Constants.typeString(getObjectType()));
- w.write("\n");
-
- w.write("tag ");
- w.write(getTag());
- w.write("\n");
-
- if (getTagger() != null) {
- w.write("tagger ");
- w.write(getTagger().toExternalString());
- w.write('\n');
- }
-
- w.write('\n');
- if (getMessage() != null)
- w.write(getMessage());
- w.close();
- } catch (IOException err) {
- // This should never occur, the only way to get it above is
- // for the ByteArrayOutputStream to throw, but it doesn't.
- //
- throw new RuntimeException(err);
- }
-
- byte[] content = os.toByteArray();
- setTagId(oi.idFor(Constants.OBJ_TAG, content));
- return content;
- }
-
- @Override
- public String toString() {
- StringBuilder r = new StringBuilder();
- r.append("Tag");
- if (tagId != null)
- r.append("[" + tagId.name() + "]");
- r.append("={\n");
-
- r.append("object ");
- r.append(object != null ? object.name() : "NOT_SET");
- r.append("\n");
-
- r.append("type ");
- r.append(object != null ? Constants.typeString(type) : "NOT_SET");
- r.append("\n");
-
- r.append("tag ");
- r.append(tag != null ? tag : "NOT_SET");
- r.append("\n");
-
- if (tagger != null) {
- r.append("tagger ");
- r.append(tagger);
- r.append("\n");
- }
-
- r.append("\n");
- r.append(message != null ? message : "");
- r.append("}");
- return r.toString();
- }
- }
|