stream/api/src/main/java/org/apache/bookkeeper/api/kv/result/RangeResult.java

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.bookkeeper.api.kv.result;

import java.util.List;

/**
 * Get result.
 */
public interface RangeResult<K, V> extends Result<K, V> {

    /**
     * Returns the number of kv pairs deleted.
     *
     * @return the number of kv pairs deleted.
     */
    long count();

    /**
     * Returns whether there is more kv pairs to fetch.
     *
     * @return whether there is more kv pairs to fetch.
     */
    boolean more();

    /**
     * Returns the list of kv pairs.
     *
     * @return the list of kv pairs.
     */
    List<KeyValue<K, V>> kvs();

    /**
     * Get the list of kv pairs and clear the kv pairs from the result.
     *
     * @return the list of kv pairs cleared from the result.
     */
    List<KeyValue<K, V>> getKvsAndClear();

}