org.spearce.jgit/src/org/spearce/jgit/revwalk/RevTag.java

   1 /*
   2  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
   3  *
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or
   7  * without modification, are permitted provided that the following
   8  * conditions are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  *
  13  * - Redistributions in binary form must reproduce the above
  14  *   copyright notice, this list of conditions and the following
  15  *   disclaimer in the documentation and/or other materials provided
  16  *   with the distribution.
  17  *
  18  * - Neither the name of the Git Development Community nor the
  19  *   names of its contributors may be used to endorse or promote
  20  *   products derived from this software without specific prior
  21  *   written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  24  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  33  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  35  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 package org.spearce.jgit.revwalk;
  39
  40 import java.io.IOException;
  41
  42 import org.spearce.jgit.errors.CorruptObjectException;
  43 import org.spearce.jgit.errors.IncorrectObjectTypeException;
  44 import org.spearce.jgit.errors.MissingObjectException;
  45 import org.spearce.jgit.lib.AnyObjectId;
  46 import org.spearce.jgit.lib.Constants;
  47 import org.spearce.jgit.lib.ObjectLoader;
  48 import org.spearce.jgit.lib.Tag;
  49 import org.spearce.jgit.util.MutableInteger;
  50 import org.spearce.jgit.util.RawParseUtils;
  51
  52 /** An annotated tag. */
  53 public class RevTag extends RevObject {
  54         private RevObject object;
  55
  56         private byte[] buffer;
  57
  58         private String name;
  59
  60         /**
  61          * Create a new tag reference.
  62          *
  63          * @param id
  64          *            object name for the tag.
  65          */
  66         protected RevTag(final AnyObjectId id) {
  67                 super(id);
  68         }
  69
  70         @Override
  71         void parse(final RevWalk walk) throws MissingObjectException,
  72                         IncorrectObjectTypeException, IOException {
  73                 final ObjectLoader ldr = walk.db.openObject(walk.curs, this);
  74                 if (ldr == null)
  75                         throw new MissingObjectException(this, Constants.TYPE_TAG);
  76                 final byte[] data = ldr.getCachedBytes();
  77                 if (Constants.OBJ_TAG != ldr.getType())
  78                         throw new IncorrectObjectTypeException(this, Constants.TYPE_TAG);
  79                 parseCanonical(walk, data);
  80         }
  81
  82         void parseCanonical(final RevWalk walk, final byte[] rawTag)
  83                         throws CorruptObjectException {
  84                 final MutableInteger pos = new MutableInteger();
  85                 final int oType;
  86
  87                 pos.value = 53; // "object $sha1\ntype "
  88                 oType = Constants.decodeTypeString(this, rawTag, (byte) '\n', pos);
  89                 walk.idBuffer.fromString(rawTag, 7);
  90                 object = walk.lookupAny(walk.idBuffer, oType);
  91
  92                 int p = pos.value += 4; // "tag "
  93                 final int nameEnd = RawParseUtils.next(rawTag, p, '\n') - 1;
  94                 name = RawParseUtils.decode(Constants.CHARSET, rawTag, p, nameEnd);
  95                 buffer = rawTag;
  96                 flags |= PARSED;
  97         }
  98
  99         /**
 100          * Parse this tag buffer for display.
 101          *
 102          * @param walk
 103          *            revision walker owning this reference.
 104          * @return parsed tag.
 105          */
 106         public Tag asTag(final RevWalk walk) {
 107                 return new Tag(walk.db, this, name, buffer);
 108         }
 109
 110         /**
 111          * Get a reference to the object this tag was placed on.
 112          *
 113          * @return object this tag refers to.
 114          */
 115         public RevObject getObject() {
 116                 return object;
 117         }
 118
 119         /**
 120          * Get the name of this tag, from the tag header.
 121          *
 122          * @return name of the tag, according to the tag header.
 123          */
 124         public String getName() {
 125                 return name;
 126         }
 127
 128         public void dispose() {
 129                 flags &= ~PARSED;
 130                 buffer = null;
 131         }
 132 }