~ubuntu-branches/ubuntu/oneiric/monodevelop/oneiric

« back to all changes in this revision

Viewing changes to contrib/NGit/NGit.Transport/PackedObjectInfo.cs

  • Committer: Bazaar Package Importer
  • Author(s): Jo Shields
  • Date: 2011-06-27 17:03:13 UTC
  • mto: (1.8.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 54.
  • Revision ID: james.westby@ubuntu.com-20110627170313-6cvz3s19x6e9hqe9
ImportĀ upstreamĀ versionĀ 2.5.92+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
This code is derived from jgit (http://eclipse.org/jgit).
 
3
Copyright owners are documented in jgit'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
using NGit;
 
45
using Sharpen;
 
46
 
 
47
namespace NGit.Transport
 
48
{
 
49
        /// <summary>Description of an object stored in a pack file, including offset.</summary>
 
50
        /// <remarks>
 
51
        /// Description of an object stored in a pack file, including offset.
 
52
        /// <p>
 
53
        /// When objects are stored in packs Git needs the ObjectId and the offset
 
54
        /// (starting position of the object data) to perform random-access reads of
 
55
        /// objects from the pack. This extension of ObjectId includes the offset.
 
56
        /// </remarks>
 
57
        [System.Serializable]
 
58
        public class PackedObjectInfo : ObjectIdOwnerMap.Entry
 
59
        {
 
60
                private long offset;
 
61
 
 
62
                private int crc;
 
63
 
 
64
                internal PackedObjectInfo(long headerOffset, int packedCRC, AnyObjectId id) : base
 
65
                        (id)
 
66
                {
 
67
                        offset = headerOffset;
 
68
                        crc = packedCRC;
 
69
                }
 
70
 
 
71
                /// <summary>Create a new structure to remember information about an object.</summary>
 
72
                /// <remarks>Create a new structure to remember information about an object.</remarks>
 
73
                /// <param name="id">the identity of the object the new instance tracks.</param>
 
74
                protected internal PackedObjectInfo(AnyObjectId id) : base(id)
 
75
                {
 
76
                }
 
77
 
 
78
                /// <returns>
 
79
                /// offset in pack when object has been already written, or 0 if it
 
80
                /// has not been written yet
 
81
                /// </returns>
 
82
                public virtual long GetOffset()
 
83
                {
 
84
                        return offset;
 
85
                }
 
86
 
 
87
                /// <summary>Set the offset in pack when object has been written to.</summary>
 
88
                /// <remarks>Set the offset in pack when object has been written to.</remarks>
 
89
                /// <param name="offset">offset where written object starts</param>
 
90
                public virtual void SetOffset(long offset)
 
91
                {
 
92
                        this.offset = offset;
 
93
                }
 
94
 
 
95
                /// <returns>the 32 bit CRC checksum for the packed data.</returns>
 
96
                public virtual int GetCRC()
 
97
                {
 
98
                        return crc;
 
99
                }
 
100
 
 
101
                /// <summary>Record the 32 bit CRC checksum for the packed data.</summary>
 
102
                /// <remarks>Record the 32 bit CRC checksum for the packed data.</remarks>
 
103
                /// <param name="crc">
 
104
                /// checksum of all packed data (including object type code,
 
105
                /// inflated length and delta base reference) as computed by
 
106
                /// <see cref="Sharpen.CRC32">Sharpen.CRC32</see>
 
107
                /// .
 
108
                /// </param>
 
109
                public virtual void SetCRC(int crc)
 
110
                {
 
111
                        this.crc = crc;
 
112
                }
 
113
        }
 
114
}