← Back to branch summary

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

« back to all changes in this revision

Viewing changes to contrib/NGit/NGit/AsyncObjectLoaderQueue.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:
contrib/NGit/NGit/AsyncObjectLoaderQueue.cs
 
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
 
48
{
 
49
        /// <summary>Queue to open objects asynchronously.</summary>
 
50
        /// <remarks>
 
51
        /// Queue to open objects asynchronously.
 
52
        /// A queue may perform background decompression of objects and supply them
 
53
        /// (possibly out-of-order) to the application.
 
54
        /// </remarks>
 
55
        /// <?></?>
 
56
        public interface AsyncObjectLoaderQueue<T> : AsyncOperation where T:ObjectId
 
57
        {
 
58
                /// <summary>Position this queue onto the next available result.</summary>
 
59
                /// <remarks>
 
60
                /// Position this queue onto the next available result.
 
61
                /// Even if this method returns true,
 
62
                /// <see cref="AsyncObjectLoaderQueue{T}.Open()">AsyncObjectLoaderQueue&lt;T&gt;.Open()
 
63
                ///     </see>
 
64
                /// may still throw
 
65
                /// <see cref="NGit.Errors.MissingObjectException">NGit.Errors.MissingObjectException
 
66
                ///     </see>
 
67
                /// if the underlying object database was
 
68
                /// concurrently modified and the current object is no longer available.
 
69
                /// </remarks>
 
70
                /// <returns>
 
71
                /// true if there is a result available; false if the queue has
 
72
                /// finished its input iteration.
 
73
                /// </returns>
 
74
                /// <exception cref="NGit.Errors.MissingObjectException">
 
75
                /// the object does not exist. If the implementation is retaining
 
76
                /// the application's objects
 
77
                /// <see cref="AsyncObjectLoaderQueue{T}.GetCurrent()">AsyncObjectLoaderQueue&lt;T&gt;.GetCurrent()
 
78
                ///     </see>
 
79
                /// will be the
 
80
                /// current object that is missing. There may be more results
 
81
                /// still available, so the caller should continue invoking next
 
82
                /// to examine another result.
 
83
                /// </exception>
 
84
                /// <exception cref="System.IO.IOException">the object store cannot be accessed.</exception>
 
85
                bool Next();
 
86
 
 
87
                /// <returns>
 
88
                /// the current object, null if the implementation lost track.
 
89
                /// Implementations may for performance reasons discard the caller's
 
90
                /// ObjectId and provider their own through
 
91
                /// <see cref="AsyncObjectLoaderQueue{T}.GetObjectId()">AsyncObjectLoaderQueue&lt;T&gt;.GetObjectId()
 
92
                ///     </see>
 
93
                /// .
 
94
                /// </returns>
 
95
                T GetCurrent();
 
96
 
 
97
                /// <returns>the ObjectId of the current object. Never null.</returns>
 
98
                ObjectId GetObjectId();
 
99
 
 
100
                /// <summary>Obtain a loader to read the object.</summary>
 
101
                /// <remarks>
 
102
                /// Obtain a loader to read the object.
 
103
                /// This method can only be invoked once per result
 
104
                /// Due to race conditions with a concurrent modification of the underlying
 
105
                /// object database, an object may be unavailable when this method is
 
106
                /// invoked, even though next returned successfully.
 
107
                /// </remarks>
 
108
                /// <returns>the ObjectLoader to read this object. Never null.</returns>
 
109
                /// <exception cref="NGit.Errors.MissingObjectException">
 
110
                /// the object does not exist. If the implementation is retaining
 
111
                /// the application's objects
 
112
                /// <see cref="AsyncObjectLoaderQueue{T}.GetCurrent()">AsyncObjectLoaderQueue&lt;T&gt;.GetCurrent()
 
113
                ///     </see>
 
114
                /// will be the
 
115
                /// current object that is missing. There may be more results
 
116
                /// still available, so the caller should continue invoking next
 
117
                /// to examine another result.
 
118
                /// </exception>
 
119
                /// <exception cref="System.IO.IOException">the object store cannot be accessed.</exception>
 
120
                ObjectLoader Open();
 
121
        }
 
122
}