Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
IteratorResultSet |
|
| 1.0;1 |
1 | package org.apache.maven.index; | |
2 | ||
3 | /* | |
4 | * Licensed to the Apache Software Foundation (ASF) under one | |
5 | * or more contributor license agreements. See the NOTICE file | |
6 | * distributed with this work for additional information | |
7 | * regarding copyright ownership. The ASF licenses this file | |
8 | * to you under the Apache License, Version 2.0 (the | |
9 | * "License"); you may not use this file except in compliance | |
10 | * with the License. You may obtain a copy of the License at | |
11 | * | |
12 | * http://www.apache.org/licenses/LICENSE-2.0 | |
13 | * | |
14 | * Unless required by applicable law or agreed to in writing, | |
15 | * software distributed under the License is distributed on an | |
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
17 | * KIND, either express or implied. See the License for the | |
18 | * specific language governing permissions and limitations | |
19 | * under the License. | |
20 | */ | |
21 | ||
22 | import java.io.Closeable; | |
23 | import java.util.Iterator; | |
24 | ||
25 | /** | |
26 | * IteratorResultSet, that returns the result hit's in "iterator-like fashion", instead lifting all the hits into memory | |
27 | * (and bashing IO and RAM consumption). This makes search making client memory usage thin, and makes possible to | |
28 | * implement things like "streaming" results etc. The result set is java.util.Iterator, but is made also | |
29 | * java.lang.Iterable to make it possible to take part in operations like "for-each", but it will usually return itself | |
30 | * as Iterator. | |
31 | * | |
32 | * @author cstamas | |
33 | */ | |
34 | public interface IteratorResultSet | |
35 | extends Iterator<ArtifactInfo>, Iterable<ArtifactInfo>, Closeable | |
36 | { | |
37 | /** | |
38 | * Returns the up-to-date number of the actual number of loaded Lucene Documents that were converted into | |
39 | * ArtifactInfo object until last next() invocation. Warning: this method will return ALL touched/loaded document | |
40 | * count, even those that are filtered out and NOT returned by iterator's next() method! | |
41 | * | |
42 | * @return total number of processed ArtifactInfos so far | |
43 | */ | |
44 | int getTotalProcessedArtifactInfoCount(); | |
45 | } |