1 /*
2 * Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
3 * Copyright (C) 2006-2007, Shawn O. Pearce <spearce@spearce.org>
4 * and other copyright owners as documented in the project's IP log.
5 *
6 * This program and the accompanying materials are made available
7 * under the terms of the Eclipse Distribution License v1.0 which
8 * accompanies this distribution, is reproduced below, and is
9 * available at http://www.eclipse.org/org/documents/edl-v10.php
10 *
11 * All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
15 * conditions are met:
16 *
17 * - Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials provided
23 * with the distribution.
24 *
25 * - Neither the name of the Eclipse Foundation, Inc. nor the
26 * names of its contributors may be used to endorse or promote
27 * products derived from this software without specific prior
28 * written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 */
44
45 package org.eclipse.jgit.lib;
46
47 import java.io.IOException;
48
49 /**
50 * A representation of a file (blob) object in a {@link Tree}.
51 *
52 * @deprecated To look up information about a single path, use
53 * {@link org.eclipse.jgit.treewalk.TreeWalk#forPath(Repository, String, org.eclipse.jgit.revwalk.RevTree)}.
54 * To lookup information about multiple paths at once, use a
55 * {@link org.eclipse.jgit.treewalk.TreeWalk} and obtain the current entry's
56 * information from its getter methods.
57 */
58 @Deprecated
59 public class FileTreeEntry extends TreeEntry {
60 private FileMode mode;
61
62 /**
63 * Constructor for a File (blob) object.
64 *
65 * @param parent
66 * The {@link Tree} holding this object (or null)
67 * @param id
68 * the SHA-1 of the blob (or null for a yet unhashed file)
69 * @param nameUTF8
70 * raw object name in the parent tree
71 * @param execute
72 * true if the executable flag is set
73 */
74 public FileTreeEntry(final Tree parent, final ObjectId id,
75 final byte[] nameUTF8, final boolean execute) {
76 super(parent, id, nameUTF8);
77 setExecutable(execute);
78 }
79
80 public FileMode getMode() {
81 return mode;
82 }
83
84 /**
85 * @return true if this file is executable
86 */
87 public boolean isExecutable() {
88 return getMode().equals(FileMode.EXECUTABLE_FILE);
89 }
90
91 /**
92 * @param execute set/reset the executable flag
93 */
94 public void setExecutable(final boolean execute) {
95 mode = execute ? FileMode.EXECUTABLE_FILE : FileMode.REGULAR_FILE;
96 }
97
98 /**
99 * @return an {@link ObjectLoader} that will return the data
100 * @throws IOException
101 */
102 public ObjectLoader openReader() throws IOException {
103 return getRepository().open(getId(), Constants.OBJ_BLOB);
104 }
105
106 public String toString() {
107 final StringBuilder r = new StringBuilder();
108 r.append(ObjectId.toString(getId()));
109 r.append(' ');
110 r.append(isExecutable() ? 'X' : 'F');
111 r.append(' ');
112 r.append(getFullName());
113 return r.toString();
114 }
115 }