Skip to content

Commit

Permalink
Create dagger.producers.Producers.immediate(Failed)Producer, so that …
Browse files Browse the repository at this point in the history
…users don't have to refer to the internal.Producers versions of those methods (or think that they aren't meant to be used, which they are.

The old methods aren't removed yet, as cleanup will be required, and probably deprecation as well

RELNOTES=Add `dagger.producers.Producers.immediate(Failed)Producer()`

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=228216479
  • Loading branch information
ronshapiro committed Jan 15, 2019
1 parent e28d535 commit 50d7010
Show file tree
Hide file tree
Showing 8 changed files with 73 additions and 3 deletions.
66 changes: 66 additions & 0 deletions java/dagger/producers/Producers.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*
* Copyright (C) 2014 The Dagger 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 dagger.producers;

import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import dagger.internal.Beta;
import dagger.producers.internal.CancellableProducer;
import dagger.producers.internal.CancellationListener;

/** Utility methods to create {@link Producer}s. */
@Beta
public final class Producers {
/** Returns a producer that succeeds with the given value. */
public static <T> Producer<T> immediateProducer(final T value) {
return new ImmediateProducer<>(Futures.immediateFuture(value));
}

/** Returns a producer that fails with the given exception. */
public static <T> Producer<T> immediateFailedProducer(final Throwable throwable) {
return new ImmediateProducer<>(Futures.<T>immediateFailedFuture(throwable));
}

/** A {@link CancellableProducer} with an immediate result. */
private static final class ImmediateProducer<T> implements CancellableProducer<T> {
private final ListenableFuture<T> future;

ImmediateProducer(ListenableFuture<T> future) {
this.future = future;
}

@Override
public ListenableFuture<T> get() {
return future;
}

@Override
public void cancel(boolean mayInterruptIfRunning) {}

@Override
public Producer<T> newDependencyView() {
return this;
}

@Override
public Producer<T> newEntryPointView(CancellationListener cancellationListener) {
return this;
}
}

private Producers() {}
}
2 changes: 1 addition & 1 deletion java/dagger/producers/internal/MapOfProducerProducer.java
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ public Producer<Map<K, Producer<V>>> newEntryPointView(

private Producer<Map<K, Producer<V>>> newTransformedValuesView(
Function<Producer<V>, Producer<V>> valueTransformationFunction) {
return Producers.<Map<K, Producer<V>>>immediateProducer(
return dagger.producers.Producers.<Map<K, Producer<V>>>immediateProducer(
ImmutableMap.copyOf(Maps.transformValues(contributingMap, valueTransformationFunction)));
}

Expand Down
2 changes: 1 addition & 1 deletion java/dagger/producers/internal/Producers.java
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ public static void cancel(Producer<?> producer, boolean mayInterruptIfRunning) {
}

private static final Producer<Map<Object, Object>> EMPTY_MAP_PRODUCER =
Producers.<Map<Object, Object>>immediateProducer(ImmutableMap.of());
dagger.producers.Producers.<Map<Object, Object>>immediateProducer(ImmutableMap.of());

@SuppressWarnings("unchecked") // safe contravariant cast
public static <K, V> Producer<Map<K, V>> emptyMapProducer() {
Expand Down
2 changes: 1 addition & 1 deletion java/dagger/producers/internal/SetProducer.java
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
*/
public final class SetProducer<T> extends AbstractProducer<Set<T>> {
private static final Producer<Set<Object>> EMPTY_PRODUCER =
Producers.<Set<Object>>immediateProducer(ImmutableSet.<Object>of());
dagger.producers.Producers.<Set<Object>>immediateProducer(ImmutableSet.<Object>of());

@SuppressWarnings({"unchecked", "rawtypes"}) // safe covariant cast
public static <T> Producer<Set<T>> empty() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import static org.junit.Assert.fail;

import dagger.producers.Producer;
import dagger.producers.Producers;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import org.junit.Test;
Expand Down
1 change: 1 addition & 0 deletions javatests/dagger/producers/internal/MapProducerTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import static org.junit.Assert.fail;

import dagger.producers.Producer;
import dagger.producers.Producers;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import org.junit.Test;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import com.google.common.collect.Sets;
import dagger.producers.Produced;
import dagger.producers.Producer;
import dagger.producers.Producers;
import java.util.Arrays;
import java.util.Collections;
import java.util.Set;
Expand Down
1 change: 1 addition & 0 deletions javatests/dagger/producers/internal/SetProducerTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import com.google.common.collect.ImmutableSet;
import com.google.common.util.concurrent.ListenableFuture;
import dagger.producers.Producer;
import dagger.producers.Producers;
import java.util.Collections;
import java.util.Set;
import java.util.concurrent.ExecutionException;
Expand Down

0 comments on commit 50d7010

Please sign in to comment.