~ubuntu-branches/ubuntu/precise/hbase/precise

« back to all changes in this revision

Viewing changes to src/java/org/apache/hadoop/hbase/client/Scanner.java

  • Committer: Bazaar Package Importer
  • Author(s): Thomas Koch
  • Date: 2010-05-06 14:20:42 UTC
  • Revision ID: james.westby@ubuntu.com-20100506142042-r3hlvgxdcpb8tynl
Tags: upstream-0.20.4+dfsg1
ImportĀ upstreamĀ versionĀ 0.20.4+dfsg1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/**
 
2
 * Copyright 2009 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
import org.apache.hadoop.hbase.io.RowResult;
 
26
 
 
27
/**
 
28
 * Interface for client-side scanning.
 
29
 * Go to {@link HTable} to obtain instances.
 
30
 * @deprecated See {@link ResultScanner}
 
31
 */
 
32
public interface Scanner extends Closeable, Iterable<RowResult> {
 
33
  /**
 
34
   * Grab the next row's worth of values.
 
35
   * @return RowResult object if there is another row, null if the scanner is
 
36
   * exhausted.
 
37
   * @throws IOException
 
38
   */  
 
39
  public RowResult next() throws IOException;
 
40
 
 
41
  /**
 
42
   * @param nbRows number of rows to return
 
43
   * @return Between zero and <param>nbRows</param> Results
 
44
   * @throws IOException
 
45
   */
 
46
  public RowResult [] next(int nbRows) throws IOException;
 
47
 
 
48
  /**
 
49
   * Closes the scanner and releases any resources it has allocated
 
50
   */
 
51
  public void close();
 
52
}
 
 
b'\\ No newline at end of file'