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

« back to all changes in this revision

Viewing changes to contrib/NGit/NGit/AsyncObjectSizeQueue.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
 
48
{
 
49
        /// <summary>Queue to examine object sizes asynchronously.</summary>
 
50
        /// <remarks>
 
51
        /// Queue to examine object sizes asynchronously.
 
52
        /// A queue may perform background lookup of object sizes and supply them
 
53
        /// (possibly out-of-order) to the application.
 
54
        /// </remarks>
 
55
        /// <?></?>
 
56
        public interface AsyncObjectSizeQueue<T> : AsyncOperation where T:ObjectId
 
57
        {
 
58
                /// <summary>Position this queue onto the next available result.</summary>
 
59
                /// <remarks>Position this queue onto the next available result.</remarks>
 
60
                /// <returns>
 
61
                /// true if there is a result available; false if the queue has
 
62
                /// finished its input iteration.
 
63
                /// </returns>
 
64
                /// <exception cref="NGit.Errors.MissingObjectException">
 
65
                /// the object does not exist. If the implementation is retaining
 
66
                /// the application's objects
 
67
                /// <see cref="AsyncObjectSizeQueue{T}.GetCurrent()">AsyncObjectSizeQueue&lt;T&gt;.GetCurrent()
 
68
                ///     </see>
 
69
                /// will be the
 
70
                /// current object that is missing. There may be more results
 
71
                /// still available, so the caller should continue invoking next
 
72
                /// to examine another result.
 
73
                /// </exception>
 
74
                /// <exception cref="System.IO.IOException">the object store cannot be accessed.</exception>
 
75
                bool Next();
 
76
 
 
77
                /// <returns>
 
78
                /// the current object, null if the implementation lost track.
 
79
                /// Implementations may for performance reasons discard the caller's
 
80
                /// ObjectId and provider their own through
 
81
                /// <see cref="AsyncObjectSizeQueue{T}.GetObjectId()">AsyncObjectSizeQueue&lt;T&gt;.GetObjectId()
 
82
                ///     </see>
 
83
                /// .
 
84
                /// </returns>
 
85
                T GetCurrent();
 
86
 
 
87
                /// <returns>the ObjectId of the current object. Never null.</returns>
 
88
                ObjectId GetObjectId();
 
89
 
 
90
                /// <returns>the size of the current object.</returns>
 
91
                long GetSize();
 
92
        }
 
93
}