Class: Vertx::Future
- Inherits:
-
Object
- Object
- Vertx::Future
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb
Overview
Direct Known Subclasses
Class Method Summary (collapse)
-
+ (::Vertx::Future) failed_future(param_1 = nil)
Create a failed future with the specified failure message.
-
+ (::Vertx::Future) future { ... }
Create a future that hasn't completed yet and that is passed to the handler before it is returned.
-
+ (::Vertx::Future) succeeded_future(result = nil)
Created a succeeded future with the specified result.
Instance Method Summary (collapse)
-
- (Exception) cause
A Throwable describing failure.
-
- (void) complete(result = nil)
Set the result.
-
- (true, false) complete?
Has the future completed? It's completed if it's either succeeded or failed.
-
- (Proc) completer
An handler completing this future.
-
- (::Vertx::Future) compose(mapper = nil) { ... }
Compose this future with a mapper function.
-
- (void) fail(param_1 = nil)
Try to set the failure.
-
- (true, false) failed?
Did it fail?.
-
- (::Vertx::Future) map(param_1 = nil)
Map the result of a future to a specific value.
-
- (::Vertx::Future) map_empty
Map the result of a future to null.
-
- (::Vertx::Future) otherwise(param_1 = nil)
Map the failure of a future to a specific value.
-
- (::Vertx::Future) otherwise_empty
Map the failure of a future to null.
-
- (::Vertx::Future) recover(mapper = nil) { ... }
Handles a failure of this Future by returning the result of another Future.
-
- (Object) result
The result of the operation.
-
- (self) set_handler { ... }
Set a handler for the result.
-
- (true, false) succeeded?
Did it succeed?.
-
- (true, false) try_complete?(result = nil)
Set the failure.
-
- (true, false) try_fail?(param_1 = nil)
Try to set the failure.
Class Method Details
+ (::Vertx::Future) failedFuture(t) + (::Vertx::Future) failedFuture(failureMessage)
47 48 49 50 51 52 53 54 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 47 def self.failed_future(param_1=nil) if param_1.is_a?(Exception) && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::Future.java_method(:failedFuture, [Java::JavaLang::Throwable.java_class]).call(::Vertx::Util::Utils.to_throwable(param_1)),::Vertx::Future, nil) elsif param_1.class == String && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::Future.java_method(:failedFuture, [Java::java.lang.String.java_class]).call(param_1),::Vertx::Future, nil) end raise ArgumentError, "Invalid arguments when calling failed_future(#{param_1})" end |
+ (::Vertx::Future) future { ... }
handler
before it is returned.
22 23 24 25 26 27 28 29 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 22 def self.future if !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::Future.java_method(:future, []).call(),::Vertx::Future, nil) elsif block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::Future.java_method(:future, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Promise, nil)) })),::Vertx::Future, nil) end raise ArgumentError, "Invalid arguments when calling future()" end |
+ (::Vertx::Future) succeeded_future(result = nil)
33 34 35 36 37 38 39 40 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 33 def self.succeeded_future(result=nil) if !block_given? && result == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::Future.java_method(:succeededFuture, []).call(),::Vertx::Future, nil) elsif ::Vertx::Util::unknown_type.accept?(result) && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxCore::Future.java_method(:succeededFuture, [Java::java.lang.Object.java_class]).call(::Vertx::Util::Utils.to_object(result)),::Vertx::Future, nil) end raise ArgumentError, "Invalid arguments when calling succeeded_future(#{result})" end |
Instance Method Details
- (Exception) cause
138 139 140 141 142 143 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 138 def cause if !block_given? return ::Vertx::Util::Utils.from_throwable(@j_del.java_method(:cause, []).call()) end raise ArgumentError, "Invalid arguments when calling cause()" end |
- (void) complete(result = nil)
This method returns an undefined value.
Set the result. Any handler will be called, if there is one, and the future will be marked as completed.
81 82 83 84 85 86 87 88 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 81 def complete(result=nil) if !block_given? && result == nil return @j_del.java_method(:complete, []).call() elsif @j_arg_T.accept?(result) && !block_given? return @j_del.java_method(:complete, [Java::java.lang.Object.java_class]).call(@j_arg_T.unwrap(result)) end raise ArgumentError, "Invalid arguments when calling complete(#{result})" end |
- (true, false) complete?
It's completed if it's either succeeded or failed.
59 60 61 62 63 64 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 59 def complete? if !block_given? return @j_del.java_method(:isComplete, []).call() end raise ArgumentError, "Invalid arguments when calling complete?()" end |
- (Proc) completer
211 212 213 214 215 216 217 218 219 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 211 def completer if !block_given? if @cached_completer != nil return @cached_completer end return @cached_completer = ::Vertx::Util::Utils.to_async_result_handler_proc(@j_del.java_method(:completer, []).call()) { |val| @j_arg_T.unwrap(val) } end raise ArgumentError, "Invalid arguments when calling completer()" end |
- (::Vertx::Future) compose(mapper = nil) { ... }
mapper
function.
When this future (the one on which compose
is called) succeeds, the mapper
will be called with
the completed value and this mapper returns another future object. This returned future completion will complete
the future returned by this method call.
If the mapper
throws an exception, the returned future will be failed with this exception.
When this future fails, the failure will be propagated to the returned future and the mapper
will not be called.
172 173 174 175 176 177 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 172 def compose(mapper=nil) if block_given? && mapper == nil return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:compose, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| yield(@j_arg_T.wrap(event)).j_del })),::Vertx::Future, nil) end raise ArgumentError, "Invalid arguments when calling compose(#{mapper})" end |
- (void) fail(cause) - (void) fail(failureMessage)
This method returns an undefined value.
Try to set the failure. When it happens, any handler will be called, if there is one, and the future will be marked as completed.
95 96 97 98 99 100 101 102 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 95 def fail(param_1=nil) if param_1.is_a?(Exception) && !block_given? return @j_del.java_method(:fail, [Java::JavaLang::Throwable.java_class]).call(::Vertx::Util::Utils.to_throwable(param_1)) elsif param_1.class == String && !block_given? return @j_del.java_method(:fail, [Java::java.lang.String.java_class]).call(param_1) end raise ArgumentError, "Invalid arguments when calling fail(#{param_1})" end |
- (true, false) failed?
154 155 156 157 158 159 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 154 def failed? if !block_given? return @j_del.java_method(:failed, []).call() end raise ArgumentError, "Invalid arguments when calling failed?()" end |
- (::Vertx::Future) map(mapper) { ... } - (::Vertx::Future) map(value)
value
.
When this future succeeds, this value
will complete the future returned by this method call.
When this future fails, the failure will be propagated to the returned future.
188 189 190 191 192 193 194 195 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 188 def map(param_1=nil) if block_given? && param_1 == nil return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:map, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| ::Vertx::Util::Utils.to_object(yield(@j_arg_T.wrap(event))) })),::Vertx::Future, nil) elsif ::Vertx::Util::unknown_type.accept?(param_1) && !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:map, [Java::java.lang.Object.java_class]).call(::Vertx::Util::Utils.to_object(param_1)),::Vertx::Future, nil) end raise ArgumentError, "Invalid arguments when calling map(#{param_1})" end |
- (::Vertx::Future) map_empty
null
.
This is a conveniency for future.map((T) null)
or future.map((Void) null)
.
When this future succeeds, null
will complete the future returned by this method call.
When this future fails, the failure will be propagated to the returned future.
204 205 206 207 208 209 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 204 def map_empty if !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:mapEmpty, []).call(),::Vertx::Future, nil) end raise ArgumentError, "Invalid arguments when calling map_empty()" end |
- (::Vertx::Future) otherwise(mapper) { ... } - (::Vertx::Future) otherwise(value)
value
.
When this future fails, this value
will complete the future returned by this method call.
When this future succeeds, the result will be propagated to the returned future.
240 241 242 243 244 245 246 247 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 240 def otherwise(param_1=nil) if block_given? && param_1 == nil return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:otherwise, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| @j_arg_T.unwrap(yield(::Vertx::Util::Utils.from_throwable(event))) })),::Vertx::Future, nil) elsif @j_arg_T.accept?(param_1) && !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:otherwise, [Java::java.lang.Object.java_class]).call(@j_arg_T.unwrap(param_1)),::Vertx::Future, nil) end raise ArgumentError, "Invalid arguments when calling otherwise(#{param_1})" end |
- (::Vertx::Future) otherwise_empty
null
.
This is a convenience for future.otherwise((T) null)
.
When this future fails, the null
value will complete the future returned by this method call.
When this future succeeds, the result will be propagated to the returned future.
256 257 258 259 260 261 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 256 def otherwise_empty if !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:otherwiseEmpty, []).call(),::Vertx::Future, nil) end raise ArgumentError, "Invalid arguments when calling otherwise_empty()" end |
- (::Vertx::Future) recover(mapper = nil) { ... }
224 225 226 227 228 229 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 224 def recover(mapper=nil) if block_given? && mapper == nil return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:recover, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)).j_del })),::Vertx::Future, nil) end raise ArgumentError, "Invalid arguments when calling recover(#{mapper})" end |
- (Object) result
130 131 132 133 134 135 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 130 def result if !block_given? return @j_arg_T.wrap(@j_del.java_method(:result, []).call()) end raise ArgumentError, "Invalid arguments when calling result()" end |
- (self) set_handler { ... }
If the future has already been completed it will be called immediately. Otherwise it will be called when the future is completed.
71 72 73 74 75 76 77 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 71 def set_handler if block_given? @j_del.java_method(:setHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? @j_arg_T.wrap(ar.result) : nil) })) return self end raise ArgumentError, "Invalid arguments when calling set_handler()" end |
- (true, false) succeeded?
146 147 148 149 150 151 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 146 def succeeded? if !block_given? return @j_del.java_method(:succeeded, []).call() end raise ArgumentError, "Invalid arguments when calling succeeded?()" end |
- (true, false) try_complete?(result = nil)
106 107 108 109 110 111 112 113 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 106 def try_complete?(result=nil) if !block_given? && result == nil return @j_del.java_method(:tryComplete, []).call() elsif @j_arg_T.accept?(result) && !block_given? return @j_del.java_method(:tryComplete, [Java::java.lang.Object.java_class]).call(@j_arg_T.unwrap(result)) end raise ArgumentError, "Invalid arguments when calling try_complete?(#{result})" end |
- (true, false) tryFail(cause) - (true, false) tryFail(failureMessage)
120 121 122 123 124 125 126 127 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/future.rb', line 120 def try_fail?(param_1=nil) if param_1.is_a?(Exception) && !block_given? return @j_del.java_method(:tryFail, [Java::JavaLang::Throwable.java_class]).call(::Vertx::Util::Utils.to_throwable(param_1)) elsif param_1.class == String && !block_given? return @j_del.java_method(:tryFail, [Java::java.lang.String.java_class]).call(param_1) end raise ArgumentError, "Invalid arguments when calling try_fail?(#{param_1})" end |