/*
 * Copyright 2018 The Vert.x Community.
 *
 * 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 io.vertx.cassandra;

import com.datastax.driver.core.ColumnDefinitions;
import com.datastax.driver.core.Row;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.Nullable;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;

import java.util.List;

It is like ResultSet, but adapted for Vert.x. 
Author:
Pavel Drankou, Thomas Segismont/**
 * It is like {@link com.datastax.driver.core.ResultSet}, but adapted for Vert.x.
 *
 * @author Pavel Drankou
 * @author Thomas Segismont
 */
@VertxGen
public interface ResultSet {

  
See Also:
isExhausted.isExhausted()/**
   * @see com.datastax.driver.core.ResultSet#isExhausted()
   */
  boolean isExhausted();

  
See Also:
isFullyFetched.isFullyFetched()/**
   * @see com.datastax.driver.core.ResultSet#isFullyFetched()
   */
  boolean isFullyFetched();

  
See Also:
getAvailableWithoutFetching.getAvailableWithoutFetching()/**
   * @see com.datastax.driver.core.ResultSet#getAvailableWithoutFetching()
   */
  int getAvailableWithoutFetching();

  
Params:
handler – handler called when result is fetched
See Also:
PagingIterable<ResultSet,Row>.fetchMoreResults()/**
   * @param handler handler called when result is fetched
   * @see com.datastax.driver.core.ResultSet#fetchMoreResults()
   */
  @Fluent
  ResultSet fetchMoreResults(Handler<AsyncResult<Void>> handler);

  
The method should not be used concurrently with others like several(int, Handler<AsyncResult<List<Row>>>) or all(Handler<AsyncResult<List<Row>>>). This may lead to unexpected result. 
Params:
handler – handler called when one row is fetched
See Also:
ResultSet.one/**
   * The method should <strong>not</strong> be used concurrently with others like {@link #several(int, Handler)} or {@link #all(Handler)}.
   * This may lead to unexpected result.
   *
   * @param handler handler called when one row is fetched
   * @see com.datastax.driver.core.ResultSet#one
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  ResultSet one(Handler<AsyncResult<@Nullable Row>> handler);

  
Fetch a specific amount of rows and notify via a handler.
 If remaining amount of rows in a result set is less than desired amount of rows to fetch, the handler will be called with a successful result encompassing just the remaining rows. 

The method should not be used concurrently with others like one(Handler<AsyncResult<Row>>) or all(Handler<AsyncResult<List<Row>>>). This may lead to unexpected result. 
Params:
handler – the handler
amount – the amount/**
   * Fetch a specific amount of rows and notify via a handler.
   * <p>
   * If remaining amount of rows in a result set is less than desired amount of rows to fetch,
   * the {@code handler} will be called with a successful result encompassing just the remaining rows.
   *
   * <p>
   * The method should <strong>not</strong> be used concurrently with others like {@link #one(Handler)} or {@link #all(Handler)}.
   * This may lead to unexpected result.
   *
   * @param handler the handler
   * @param amount the amount
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  ResultSet several(int amount, Handler<AsyncResult<List<Row>>> handler);

  
The method should not be used concurrently with others like several(int, Handler<AsyncResult<List<Row>>>) or one(Handler<AsyncResult<Row>>). This may lead to unexpected result. 
Params:
handler – handler called when all the rows is fetched
See Also:
PagingIterable<ResultSet,Row>.all/**
   * The method should <strong>not</strong> be used concurrently with others like {@link #several(int, Handler)} or {@link #one(Handler)}.
   * This may lead to unexpected result.
   *
   * @param handler handler called when all the rows is fetched
   * @see com.datastax.driver.core.ResultSet#all
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  @Fluent
  ResultSet all(Handler<AsyncResult<List<Row>>> handler);

  
See Also:
getColumnDefinitions.getColumnDefinitions/**
   * @see com.datastax.driver.core.ResultSet#getColumnDefinitions
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  ColumnDefinitions getColumnDefinitions();

  
See Also:
wasApplied.wasApplied/**
   * @see com.datastax.driver.core.ResultSet#wasApplied
   */
  boolean wasApplied();
}