io.vertx.reactivex.ext.sql.SQLRowStream Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat licenses this file to you 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.reactivex.ext.sql;

import java.util.Map;
import io.reactivex.Observable;
import io.reactivex.Flowable;
import io.reactivex.Single;
import io.reactivex.Completable;
import io.reactivex.Maybe;
import io.vertx.core.json.JsonArray;
import java.util.List;
import io.vertx.reactivex.core.streams.ReadStream;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;

/**
 * A ReadStream of Rows from the underlying RDBMS. This class follows the ReadStream semantics and will automatically
 * close the underlying resources if all returned rows are returned. For cases where the results are ignored before the
 * full processing of the returned rows is complete the close method **MUST** be called in order to release underlying
 * resources.
 *
 * The interface is minimal in order to support all SQL clients not just JDBC.
 *
 * 
 * NOTE: This class has been automatically generated from the {@link io.vertx.ext.sql.SQLRowStream original} non RX-ified interface using Vert.x codegen.
 */

@io.vertx.lang.reactivex.RxGen(io.vertx.ext.sql.SQLRowStream.class)
public class SQLRowStream implements ReadStream {

  @Override
  public String toString() {
    return delegate.toString();
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    SQLRowStream that = (SQLRowStream) o;
    return delegate.equals(that.delegate);
  }
  
  @Override
  public int hashCode() {
    return delegate.hashCode();
  }

  public static final io.vertx.lang.reactivex.TypeArg __TYPE_ARG = new io.vertx.lang.reactivex.TypeArg<>(
    obj -> new SQLRowStream((io.vertx.ext.sql.SQLRowStream) obj),
    SQLRowStream::getDelegate
  );

  private final io.vertx.ext.sql.SQLRowStream delegate;
  
  public SQLRowStream(io.vertx.ext.sql.SQLRowStream delegate) {
    this.delegate = delegate;
  }

  public io.vertx.ext.sql.SQLRowStream getDelegate() {
    return delegate;
  }

  private io.reactivex.Observable observable;
  private io.reactivex.Flowable flowable;

  public synchronized io.reactivex.Observable toObservable() {
    if (observable == null) {
      observable = io.vertx.reactivex.ObservableHelper.toObservable(this.getDelegate());
    }
    return observable;
  }

  public synchronized io.reactivex.Flowable toFlowable() {
    if (flowable == null) {
      flowable = io.vertx.reactivex.FlowableHelper.toFlowable(this.getDelegate());
    }
    return flowable;
  }

  public SQLRowStream exceptionHandler(Handler handler) { 
    delegate.exceptionHandler(handler);
    return this;
  }

  public SQLRowStream handler(Handler handler) { 
    delegate.handler(handler);
    return this;
  }

  public SQLRowStream pause() { 
    delegate.pause();
    return this;
  }

  public SQLRowStream resume() { 
    delegate.resume();
    return this;
  }

  public SQLRowStream endHandler(Handler endHandler) { 
    delegate.endHandler(endHandler);
    return this;
  }

  /**
   * Will convert the column name to the json array index.
   * @param name the column name
   * @return the json array index
   */
  public int column(String name) { 
    int ret = delegate.column(name);
    return ret;
  }

  /**
   * Returns all column names available in the underlying resultset. One needs to carefully use this method since in
   * contrast to the singular version it does not perform case insensitive lookups or takes alias in consideration on
   * the column names.
   * @return the list of columns names returned by the query
   */
  public List columns() { 
    List ret = delegate.columns();
    return ret;
  }

  /**
   * Event handler when a resultset is closed. This is useful to request for more results.
   * @param handler called when the current result set is closed
   * @return 
   */
  public SQLRowStream resultSetClosedHandler(Handler handler) { 
    delegate.resultSetClosedHandler(handler);
    return this;
  }

  /**
   * Request for more results if available
   */
  public void moreResults() { 
    delegate.moreResults();
  }

  /**
   * Closes the stream/underlying cursor(s). The actual close happens asynchronously.
   */
  public void close() { 
    delegate.close();
  }

  /**
   * Closes the stream/underlying cursor(s). The actual close happens asynchronously.
   * @param handler called when the stream/underlying cursor(s) is(are) closed
   */
  public void close(Handler> handler) { 
    delegate.close(handler);
  }

  /**
   * Closes the stream/underlying cursor(s). The actual close happens asynchronously.
   * @return 
   */
  public Completable rxClose() { 
    return new io.vertx.reactivex.core.impl.AsyncResultCompletable(handler -> {
      close(handler);
    });
  }


  public static  SQLRowStream newInstance(io.vertx.ext.sql.SQLRowStream arg) {
    return arg != null ? new SQLRowStream(arg) : null;
  }
}