View Javadoc

1   /**
2    * Copyright 2010 The Apache Software Foundation
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, software
15   * distributed under the License is distributed on an "AS IS" BASIS,
16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17   * See the License for the specific language governing permissions and
18   * limitations under the License.
19   */
20  package org.apache.hadoop.hbase.client;
21  
22  import java.io.Closeable;
23  import java.io.IOException;
24  
25  /**
26   * Interface for client-side scanning.
27   * Go to {@link HTable} to obtain instances.
28   */
29  public interface ResultScanner extends Closeable, Iterable<Result> {
30  
31    /**
32     * Grab the next row's worth of values. The scanner will return a Result.
33     * @return Result object if there is another row, null if the scanner is
34     * exhausted.
35     * @throws IOException e
36     */
37    public Result next() throws IOException;
38  
39    /**
40     * @param nbRows number of rows to return
41     * @return Between zero and <param>nbRows</param> Results
42     * @throws IOException e
43     */
44    public Result [] next(int nbRows) throws IOException;
45  
46    /**
47     * Closes the scanner and releases any resources it has allocated
48     */
49    public void close();
50  }