Move MonoToListenableFutureAdapter to spring-core

This was a package private class in spring-messaging since 5.0, and was
recently made public in 5.1. This commit promotes it to spring-core
where it belongs next to all other ListenableFuture support classes.

Follow-up refactoring for SPR-17336
This commit is contained in:
Rossen Stoyanchev
2018-10-09 16:26:24 -04:00
parent 928c541401
commit c01f350abe
6 changed files with 101 additions and 50 deletions

View File

@@ -0,0 +1,97 @@
/*
* Copyright 2002-2018 the original author or authors.
*
* 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 org.springframework.util.concurrent;
import java.time.Duration;
import java.util.concurrent.TimeUnit;
import reactor.core.publisher.Mono;
import reactor.core.publisher.MonoProcessor;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Adapts a {@link Mono} into a {@link ListenableFuture}.
*
* @author Rossen Stoyanchev
* @author Stephane Maldini
* @since 5.1
* @param <T> the object type
*/
public class MonoToListenableFutureAdapter<T> implements ListenableFuture<T> {
private final MonoProcessor<T> processor;
private final ListenableFutureCallbackRegistry<T> registry = new ListenableFutureCallbackRegistry<>();
public MonoToListenableFutureAdapter(Mono<T> mono) {
Assert.notNull(mono, "Mono must not be null");
this.processor = mono
.doOnSuccess(this.registry::success)
.doOnError(this.registry::failure)
.toProcessor();
}
@Override
@Nullable
public T get() {
return this.processor.block();
}
@Override
@Nullable
public T get(long timeout, TimeUnit unit) {
Assert.notNull(unit, "TimeUnit must not be null");
Duration duration = Duration.ofMillis(TimeUnit.MILLISECONDS.convert(timeout, unit));
return this.processor.block(duration);
}
@Override
public boolean cancel(boolean mayInterruptIfRunning) {
if (isCancelled()) {
return false;
}
this.processor.cancel();
// isCancelled may still return false, if mono completed before the cancel
return this.processor.isCancelled();
}
@Override
public boolean isCancelled() {
return this.processor.isCancelled();
}
@Override
public boolean isDone() {
return this.processor.isTerminated();
}
@Override
public void addCallback(ListenableFutureCallback<? super T> callback) {
this.registry.addCallback(callback);
}
@Override
public void addCallback(SuccessCallback<? super T> success, FailureCallback failure) {
this.registry.addSuccessCallback(success);
this.registry.addFailureCallback(failure);
}
}

View File

@@ -0,0 +1,70 @@
/*
* Copyright 2002-2018 the original author or authors.
*
* 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 org.springframework.util.concurrent;
import java.time.Duration;
import java.util.concurrent.Future;
import java.util.concurrent.atomic.AtomicReference;
import org.junit.Test;
import reactor.core.publisher.Mono;
import static org.junit.Assert.*;
/**
* Unit tests for {@link MonoToListenableFutureAdapter}.
* @author Rossen Stoyanchev
*/
public class MonoToListenableFutureAdapterTests {
@Test
public void success() {
String expected = "one";
AtomicReference<Object> actual = new AtomicReference<>();
ListenableFuture<String> future = new MonoToListenableFutureAdapter<>(Mono.just(expected));
future.addCallback(actual::set, actual::set);
assertEquals(expected, actual.get());
}
@Test
public void failure() {
Throwable expected = new IllegalStateException("oops");
AtomicReference<Object> actual = new AtomicReference<>();
ListenableFuture<String> future = new MonoToListenableFutureAdapter<>(Mono.error(expected));
future.addCallback(actual::set, actual::set);
assertEquals(expected, actual.get());
}
@Test
public void cancellation() {
Mono<Long> mono = Mono.delay(Duration.ofSeconds(60));
Future<Long> future = new MonoToListenableFutureAdapter<>(mono);
assertTrue(future.cancel(true));
assertTrue(future.isCancelled());
}
@Test
public void cancellationAfterTerminated() {
Future<Void> future = new MonoToListenableFutureAdapter<>(Mono.empty());
assertFalse("Should return false if task already completed", future.cancel(true));
assertFalse(future.isCancelled());
}
}