1 /**
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 */
19 package org.apache.hadoop.hbase.client;
20
21 import org.apache.hadoop.hbase.classification.InterfaceAudience;
22 import org.apache.hadoop.hbase.classification.InterfaceStability;
23
24 import java.io.Closeable;
25 import java.io.IOException;
26
27 /**
28 * Interface for client-side scanning.
29 * Go to {@link Table} to obtain instances.
30 */
31 @InterfaceAudience.Public
32 @InterfaceStability.Stable
33 public interface ResultScanner extends Closeable, Iterable<Result> {
34
35 /**
36 * Grab the next row's worth of values. The scanner will return a Result.
37 * @return Result object if there is another row, null if the scanner is
38 * exhausted.
39 * @throws IOException e
40 */
41 Result next() throws IOException;
42
43 /**
44 * @param nbRows number of rows to return
45 * @return Between zero and nbRows results
46 * @throws IOException e
47 */
48 Result [] next(int nbRows) throws IOException;
49
50 /**
51 * Closes the scanner and releases any resources it has allocated
52 */
53 @Override
54 void close();
55 }