1 /* 2 * Copyright (C) 2010, Google Inc. 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 44 package org.eclipse.jgit.lib; 45 46 /** 47 * A reference that indirectly points at another {@link Ref}. 48 * <p> 49 * A symbolic reference always derives its current value from the target 50 * reference. 51 */ 52 public class SymbolicRef implements Ref { 53 private final String name; 54 55 private final Ref target; 56 57 /** 58 * Create a new ref pairing. 59 * 60 * @param refName 61 * name of this ref. 62 * @param target 63 * the ref we reference and derive our value from. 64 */ 65 public SymbolicRef(String refName, Ref target) { 66 this.name = refName; 67 this.target = target; 68 } 69 70 public String getName() { 71 return name; 72 } 73 74 public boolean isSymbolic() { 75 return true; 76 } 77 78 public Ref getLeaf() { 79 Ref dst = getTarget(); 80 while (dst.isSymbolic()) 81 dst = dst.getTarget(); 82 return dst; 83 } 84 85 public Ref getTarget() { 86 return target; 87 } 88 89 public ObjectId getObjectId() { 90 return getLeaf().getObjectId(); 91 } 92 93 public Storage getStorage() { 94 return Storage.LOOSE; 95 } 96 97 public ObjectId getPeeledObjectId() { 98 return getLeaf().getPeeledObjectId(); 99 } 100 101 public boolean isPeeled() { 102 return getLeaf().isPeeled(); 103 } 104 105 @SuppressWarnings("nls") 106 @Override 107 public String toString() { 108 StringBuilder r = new StringBuilder(); 109 r.append("SymbolicRef["); 110 Ref cur = this; 111 while (cur.isSymbolic()) { 112 r.append(cur.getName()); 113 r.append(" -> "); 114 cur = cur.getTarget(); 115 } 116 r.append(cur.getName()); 117 r.append('='); 118 r.append(ObjectId.toString(cur.getObjectId())); 119 r.append("]"); 120 return r.toString(); 121 } 122 }