/*
 * 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.oss.driver.api.core.cql.AsyncResultSet;
import com.datastax.oss.driver.api.core.cql.ColumnDefinitions;
import com.datastax.oss.driver.api.core.cql.ExecutionInfo;
import com.datastax.oss.driver.api.core.cql.Row;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;

import java.util.List;

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

  
Like all(Handler<AsyncResult<List<Row>>>) but returns a Future of the asynchronous result. /**
   * Like {@link #all(Handler)} but returns a {@code Future} of the asynchronous result.
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  Future<List<Row>> all();

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

  
See Also:
getColumnDefinitions.getColumnDefinitions()/**
   * @see AsyncResultSet#getColumnDefinitions()
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  ColumnDefinitions getColumnDefinitions();

  
See Also:
getExecutionInfo.getExecutionInfo()/**
   * @see AsyncResultSet#getExecutionInfo()
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  ExecutionInfo getExecutionInfo();

  
See Also:
remaining.remaining()/**
   * @see AsyncResultSet#remaining()
   */
  int remaining();

  
See Also:
currentPage.currentPage()/**
   * @see AsyncResultSet#currentPage()
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  Iterable<Row> currentPage();

  
See Also:
one.one()/**
   * @see AsyncResultSet#one()
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  Row one();

  
See Also:
hasMorePages.hasMorePages()/**
   * @see AsyncResultSet#hasMorePages()
   */
  boolean hasMorePages();

  
Like fetchNextPage() but with a direct callback. /**
   * Like {@link #fetchNextPage()} but with a direct callback.
   */
  void fetchNextPage(Handler<AsyncResult<ResultSet>> handler);

  
See Also:
wasApplied.wasApplied()/**
   * @see AsyncResultSet#wasApplied()
   */
  Future<ResultSet> fetchNextPage() throws IllegalStateException;

  
See Also:
wasApplied.wasApplied()/**
   * @see AsyncResultSet#wasApplied()
   */
  boolean wasApplied();
}