org.spearce.jgit/src/org/spearce/jgit/lib/FileTreeEntry.java

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