/*
 * 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.unit;

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.AsyncResult;
import io.vertx.core.Handler;

A completion object that emits completion notifications either succeeded or failed.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.
/** * A completion object that emits completion notifications either <i>succeeded</i> or <i>failed</i>. * * <p/> * NOTE: This class has been automatically generated from the {@link io.vertx.ext.unit.Completion original} non RX-ified interface using Vert.x codegen. */
@io.vertx.lang.rx.RxGen(io.vertx.ext.unit.Completion.class) public class Completion<T> { @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; Completion that = (Completion) o; return delegate.equals(that.delegate); } @Override public int hashCode() { return delegate.hashCode(); } public static final io.vertx.lang.rx.TypeArg<Completion> __TYPE_ARG = new io.vertx.lang.rx.TypeArg<>( obj -> new Completion((io.vertx.ext.unit.Completion) obj), Completion::getDelegate ); private final io.vertx.ext.unit.Completion<T> delegate; public final io.vertx.lang.rx.TypeArg<T> __typeArg_0; public Completion(io.vertx.ext.unit.Completion delegate) { this.delegate = delegate; this.__typeArg_0 = io.vertx.lang.rx.TypeArg.unknown(); } public Completion(io.vertx.ext.unit.Completion delegate, io.vertx.lang.rx.TypeArg<T> typeArg_0) { this.delegate = delegate; this.__typeArg_0 = typeArg_0; } public io.vertx.ext.unit.Completion getDelegate() { return delegate; }
Completes the future upon completion, otherwise fails it.
Params:
  • future – the future to resolve
/** * Completes the future upon completion, otherwise fails it. * @param future the future to resolve */
public void resolve(io.vertx.reactivex.core.Promise<T> future) { delegate.resolve(future.getDelegate()); }
Returns:true if this completion is completed
/** * @return true if this completion is completed */
public boolean isCompleted() { boolean ret = delegate.isCompleted(); return ret; }
Returns:true if this completion is completed and succeeded
/** * @return true if this completion is completed and succeeded */
public boolean isSucceeded() { boolean ret = delegate.isSucceeded(); return ret; }
Returns:true if the this completion is completed and failed
/** * @return true if the this completion is completed and failed */
public boolean isFailed() { boolean ret = delegate.isFailed(); return ret; }
Completion handler to receive a completion signal when this completions completes.
Params:
  • completionHandler – the completion handler
/** * Completion handler to receive a completion signal when this completions completes. * @param completionHandler the completion handler */
public void handler(Handler<AsyncResult<T>> completionHandler) { delegate.handler(new Handler<AsyncResult<T>>() { public void handle(AsyncResult<T> ar) { if (ar.succeeded()) { completionHandler.handle(io.vertx.core.Future.succeededFuture((T)__typeArg_0.wrap(ar.result()))); } else { completionHandler.handle(io.vertx.core.Future.failedFuture(ar.cause())); } } }); }
Completion handler to receive a completion signal when this completions completes.
Returns:
/** * Completion handler to receive a completion signal when this completions completes. * @return */
public Maybe<T> rxHandler() { return io.vertx.reactivex.impl.AsyncResultMaybe.toMaybe(handler -> { handler(handler); }); }
Cause the current thread to wait until this completion completes.

If the current thread is interrupted, an exception will be thrown.
/** * Cause the current thread to wait until this completion completes.<p/> * * If the current thread is interrupted, an exception will be thrown. */
public void await() { delegate.await(); }
Cause the current thread to wait until this completion completes with a configurable timeout.

If completion times out or the current thread is interrupted, an exception will be thrown.
Params:
  • timeoutMillis – the timeout in milliseconds
/** * Cause the current thread to wait until this completion completes with a configurable timeout.<p/> * * If completion times out or the current thread is interrupted, an exception will be thrown. * @param timeoutMillis the timeout in milliseconds */
public void await(long timeoutMillis) { delegate.await(timeoutMillis); }
Cause the current thread to wait until this completion completes and succeeds.

If the current thread is interrupted or the suite fails, an exception will be thrown.
/** * Cause the current thread to wait until this completion completes and succeeds.<p/> * * If the current thread is interrupted or the suite fails, an exception will be thrown. */
public void awaitSuccess() { delegate.awaitSuccess(); }
Cause the current thread to wait until this completion completes and succeeds with a configurable timeout.

If completion times out or the current thread is interrupted or the suite fails, an exception will be thrown.
Params:
  • timeoutMillis – the timeout in milliseconds
/** * Cause the current thread to wait until this completion completes and succeeds with a configurable timeout.<p/> * * If completion times out or the current thread is interrupted or the suite fails, an exception will be thrown. * @param timeoutMillis the timeout in milliseconds */
public void awaitSuccess(long timeoutMillis) { delegate.awaitSuccess(timeoutMillis); } public static <T>Completion<T> newInstance(io.vertx.ext.unit.Completion arg) { return arg != null ? new Completion<T>(arg) : null; } public static <T>Completion<T> newInstance(io.vertx.ext.unit.Completion arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T) { return arg != null ? new Completion<T>(arg, __typeArg_T) : null; } }