001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.client;
019
020import org.apache.yetus.audience.InterfaceAudience;
021
022/**
023 * Receives {@link Result} for an asynchronous scan.
024 * <p>
025 * All results that match the given scan object will be passed to this class by calling
026 * {@link #onNext(Result)}. {@link #onComplete()} means the scan is finished, and
027 * {@link #onError(Throwable)} means we hit an unrecoverable error and the scan is terminated.
028 */
029@InterfaceAudience.Public
030public interface ScanResultConsumer extends ScanResultConsumerBase {
031
032  /**
033   * @param result the data fetched from HBase service.
034   * @return {@code false} if you want to terminate the scan process. Otherwise {@code true}
035   */
036  boolean onNext(Result result);
037}