GitSharp/Tag.cs

   1 /*
   2  * Copyright (C) 2009, Henon <meinrad.recheis@gmail.com>
   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 using System;
  39 using System.Collections.Generic;
  40 using System.Linq;
  41 using System.Text;
  42
  43 using ObjectId = GitSharp.Core.ObjectId;
  44 using CoreRef = GitSharp.Core.Ref;
  45 using CoreCommit = GitSharp.Core.Commit;
  46 using CoreTree = GitSharp.Core.Tree;
  47 using CoreTag = GitSharp.Core.Tag;
  48
  49 namespace GitSharp
  50 {
  51         /// <summary>
  52         /// Represents a git tag.
  53         /// </summary>
  54         public class Tag : AbstractObject, IReferenceObject
  55         {
  56
  57                 public Tag(Repository repo, string name)
  58                         : base(repo, name)
  59                 {
  60                         _name = name;
  61                 }
  62
  63                 private string _name; // <--- need the name for resolving purposes only. once the internal tag is resolved, this field is not used any more.
  64
  65                 internal Tag(Repository repo, CoreRef @ref)
  66                         : base(repo, @ref.ObjectId)
  67                 {
  68                         _name = @ref.Name;
  69                 }
  70
  71                 internal Tag(Repository repo, CoreTag internal_tag)
  72                         : base(repo, internal_tag.Id)
  73                 {
  74                         _internal_tag = internal_tag;
  75                 }
  76
  77                 internal Tag(Repository repo, ObjectId id, string name)
  78                         : base(repo, id)
  79                 {
  80                         _name = name;
  81                 }
  82
  83                 private CoreTag _internal_tag;
  84
  85                 private CoreTag InternalTag
  86                 {
  87                         get
  88                         {
  89                                 if (_internal_tag == null)
  90                                         try
  91                                         {
  92                                                 _internal_tag = _repo._internal_repo.MapTag(_name, _id);
  93                                         }
  94                                         catch (Exception)
  95                                         {
  96                                                 // the object is invalid. however, we can not allow exceptions here because they would not be expected.
  97                                         }
  98                                 return _internal_tag;
  99                         }
 100                 }
 101
 102                 public override bool IsTag
 103                 {
 104                         get
 105                         {
 106                                 if (InternalTag == null)
 107                                         return false;
 108                                 return true;
 109                         }
 110                 }
 111
 112                 /// <summary>
 113                 /// The tag name.
 114                 /// </summary>
 115                 public string Name
 116                 {
 117                         get
 118                         {
 119                                 if (InternalTag == null)
 120                                         return _name;
 121                                 return InternalTag.TagName;
 122                         }
 123                 }
 124
 125                 /// <summary>
 126                 /// The object that has been tagged.
 127                 /// </summary>
 128                 public AbstractObject Target
 129                 {
 130                         get
 131                         {
 132                                 if (InternalTag == null)
 133                                         return null;
 134                                 if (InternalTag.TagId == InternalTag.Id) // <--- it can happen!
 135                                         return this;
 136                                 return AbstractObject.Wrap(_repo, InternalTag.Id);
 137                         }
 138                 }
 139
 140                 public override string ToString()
 141                 {
 142                         return "Tag[" + ShortHash + "]";
 143                 }
 144         }
 145 }