org.spearce.jgit/src/org/spearce/jgit/transport/PackedObjectInfo.java

   1 /*
   2  * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.com>
   3  * Copyright (C) 2008, 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.transport;
  40
  41 import org.spearce.jgit.lib.AnyObjectId;
  42 import org.spearce.jgit.lib.ObjectId;
  43
  44 /**
  45  * Description of an object stored in a pack file, including offset.
  46  * <p>
  47  * When objects are stored in packs Git needs the ObjectId and the offset
  48  * (starting position of the object data) to perform random-access reads of
  49  * objects from the pack. This extension of ObjectId includes the offset.
  50  */
  51 public class PackedObjectInfo extends ObjectId {
  52         private long offset;
  53
  54         PackedObjectInfo(final long headerOffset, final AnyObjectId id) {
  55                 super(id);
  56                 offset = headerOffset;
  57         }
  58
  59         /**
  60          * Create a new structure to remember information about an object.
  61          *
  62          * @param id
  63          *            the identity of the object the new instance tracks.
  64          */
  65         public PackedObjectInfo(final AnyObjectId id) {
  66                 super(id);
  67         }
  68
  69         /**
  70          * @return offset in pack when object has been already written, or 0 if it
  71          *         has not been written yet
  72          */
  73         public long getOffset() {
  74                 return offset;
  75         }
  76
  77         /**
  78          * Set the offset in pack when object has been written to.
  79          *
  80          * @param offset
  81          *            offset where written object starts
  82          */
  83         public void setOffset(final long offset) {
  84                 this.offset = offset;
  85         }
  86 }