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