hbase-client/src/main/java/org/apache/hadoop/hbase/client/ScanResultConsumer.java

   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, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package org.apache.hadoop.hbase.client;
  19
  20 import org.apache.yetus.audience.InterfaceAudience;
  21
  22 /**
  23  * Receives {@link Result} for an asynchronous scan.
  24  * <p>
  25  * All results that match the given scan object will be passed to this class by calling
  26  * {@link #onNext(Result)}. {@link #onComplete()} means the scan is finished, and
  27  * {@link #onError(Throwable)} means we hit an unrecoverable error and the scan is terminated.
  28  */
  29 @InterfaceAudience.Public
  30 public interface ScanResultConsumer extends ScanResultConsumerBase {
  31
  32   /**
  33    * @param result the data fetched from HBase service.
  34    * @return {@code false} if you want to terminate the scan process. Otherwise {@code true}
  35    */
  36   boolean onNext(Result result);
  37 }