View Javadoc
1   /*
2    * Copyright (C) 2009, Jonas Fonseca <fonseca@diku.dk>
3    * Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
4    * Copyright (C) 2007, Shawn O. Pearce <spearce@spearce.org>
5    * and other copyright owners as documented in the project's IP log.
6    *
7    * This program and the accompanying materials are made available
8    * under the terms of the Eclipse Distribution License v1.0 which
9    * accompanies this distribution, is reproduced below, and is
10   * available at http://www.eclipse.org/org/documents/edl-v10.php
11   *
12   * All rights reserved.
13   *
14   * Redistribution and use in source and binary forms, with or
15   * without modification, are permitted provided that the following
16   * conditions are met:
17   *
18   * - Redistributions of source code must retain the above copyright
19   *   notice, this list of conditions and the following disclaimer.
20   *
21   * - Redistributions in binary form must reproduce the above
22   *   copyright notice, this list of conditions and the following
23   *   disclaimer in the documentation and/or other materials provided
24   *   with the distribution.
25   *
26   * - Neither the name of the Eclipse Foundation, Inc. nor the
27   *   names of its contributors may be used to endorse or promote
28   *   products derived from this software without specific prior
29   *   written permission.
30   *
31   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
32   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
33   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
36   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
38   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
39   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
40   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
43   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44   */
45  
46  package org.eclipse.jgit.lib;
47  
48  /**
49   * A tree entry representing a gitlink entry used for submodules.
50   *
51   * Note. Java cannot really handle these as file system objects.
52   *
53   * @deprecated To look up information about a single path, use
54   * {@link org.eclipse.jgit.treewalk.TreeWalk#forPath(Repository, String, org.eclipse.jgit.revwalk.RevTree)}.
55   * To lookup information about multiple paths at once, use a
56   * {@link org.eclipse.jgit.treewalk.TreeWalk} and obtain the current entry's
57   * information from its getter methods.
58   */
59  @Deprecated
60  public class GitlinkTreeEntry extends TreeEntry {
61  
62  	/**
63  	 * Construct a {@link GitlinkTreeEntry} with the specified name and SHA-1 in
64  	 * the specified parent
65  	 *
66  	 * @param parent
67  	 * @param id
68  	 * @param nameUTF8
69  	 */
70  	public GitlinkTreeEntry(final Tree parent, final ObjectId id,
71  			final byte[] nameUTF8) {
72  		super(parent, id, nameUTF8);
73  	}
74  
75  	public FileMode getMode() {
76  		return FileMode.GITLINK;
77  	}
78  
79  	@Override
80  	public String toString() {
81  		final StringBuilder r = new StringBuilder();
82  		r.append(ObjectId.toString(getId()));
83  		r.append(" G "); //$NON-NLS-1$
84  		r.append(getFullName());
85  		return r.toString();
86  	}
87  }