xref: /aosp_15_r20/external/dagger2/java/dagger/producers/internal/DelegateProducer.java (revision f585d8a307d0621d6060bd7e80091fdcbf94fe27)
1*f585d8a3SJacky Wang /*
2*f585d8a3SJacky Wang  * Copyright (C) 2018 The Dagger Authors.
3*f585d8a3SJacky Wang  *
4*f585d8a3SJacky Wang  * Licensed under the Apache License, Version 2.0 (the "License");
5*f585d8a3SJacky Wang  * you may not use this file except in compliance with the License.
6*f585d8a3SJacky Wang  * You may obtain a copy of the License at
7*f585d8a3SJacky Wang  *
8*f585d8a3SJacky Wang  * http://www.apache.org/licenses/LICENSE-2.0
9*f585d8a3SJacky Wang  *
10*f585d8a3SJacky Wang  * Unless required by applicable law or agreed to in writing, software
11*f585d8a3SJacky Wang  * distributed under the License is distributed on an "AS IS" BASIS,
12*f585d8a3SJacky Wang  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*f585d8a3SJacky Wang  * See the License for the specific language governing permissions and
14*f585d8a3SJacky Wang  * limitations under the License.
15*f585d8a3SJacky Wang  */
16*f585d8a3SJacky Wang 
17*f585d8a3SJacky Wang package dagger.producers.internal;
18*f585d8a3SJacky Wang 
19*f585d8a3SJacky Wang import static dagger.internal.Preconditions.checkNotNull;
20*f585d8a3SJacky Wang 
21*f585d8a3SJacky Wang import com.google.common.util.concurrent.ListenableFuture;
22*f585d8a3SJacky Wang import dagger.internal.DoubleCheck;
23*f585d8a3SJacky Wang import dagger.internal.Provider;
24*f585d8a3SJacky Wang import dagger.producers.Producer;
25*f585d8a3SJacky Wang 
26*f585d8a3SJacky Wang /**
27*f585d8a3SJacky Wang  * A DelegateProducer that is used to stitch Producer indirection during initialization across
28*f585d8a3SJacky Wang  * partial subcomponent implementations.
29*f585d8a3SJacky Wang  */
30*f585d8a3SJacky Wang public final class DelegateProducer<T> implements CancellableProducer<T> {
31*f585d8a3SJacky Wang   private CancellableProducer<T> delegate;
32*f585d8a3SJacky Wang 
33*f585d8a3SJacky Wang   @Override
get()34*f585d8a3SJacky Wang   public ListenableFuture<T> get() {
35*f585d8a3SJacky Wang     return delegate.get();
36*f585d8a3SJacky Wang   }
37*f585d8a3SJacky Wang 
38*f585d8a3SJacky Wang   // TODO(ronshapiro): remove this once we can reasonably expect generated code is no longer using
39*f585d8a3SJacky Wang   // this method
40*f585d8a3SJacky Wang   @Deprecated
setDelegatedProducer(Producer<T> delegate)41*f585d8a3SJacky Wang   public void setDelegatedProducer(Producer<T> delegate) {
42*f585d8a3SJacky Wang     setDelegate(this, delegate);
43*f585d8a3SJacky Wang   }
44*f585d8a3SJacky Wang 
45*f585d8a3SJacky Wang   /**
46*f585d8a3SJacky Wang    * Sets {@code delegateProducer}'s delegate producer to {@code delegate}.
47*f585d8a3SJacky Wang    *
48*f585d8a3SJacky Wang    * <p>{@code delegateProducer} must be an instance of {@link DelegateProducer}, otherwise this
49*f585d8a3SJacky Wang    * method will throw a {@link ClassCastException}.
50*f585d8a3SJacky Wang    */
setDelegate(Producer<T> delegateProducer, Producer<T> delegate)51*f585d8a3SJacky Wang   public static <T> void setDelegate(Producer<T> delegateProducer, Producer<T> delegate) {
52*f585d8a3SJacky Wang     checkNotNull(delegate);
53*f585d8a3SJacky Wang     DelegateProducer<T> asDelegateProducer = (DelegateProducer<T>) delegateProducer;
54*f585d8a3SJacky Wang     if (asDelegateProducer.delegate != null) {
55*f585d8a3SJacky Wang       throw new IllegalStateException();
56*f585d8a3SJacky Wang     }
57*f585d8a3SJacky Wang     asDelegateProducer.delegate = (CancellableProducer<T>) delegate;
58*f585d8a3SJacky Wang   }
59*f585d8a3SJacky Wang 
60*f585d8a3SJacky Wang   /**
61*f585d8a3SJacky Wang    * Returns the factory's delegate.
62*f585d8a3SJacky Wang    *
63*f585d8a3SJacky Wang    * @throws NullPointerException if the delegate has not been set
64*f585d8a3SJacky Wang    */
getDelegate()65*f585d8a3SJacky Wang   CancellableProducer<T> getDelegate() {
66*f585d8a3SJacky Wang     return checkNotNull(delegate);
67*f585d8a3SJacky Wang   }
68*f585d8a3SJacky Wang 
69*f585d8a3SJacky Wang   @Override
cancel(boolean mayInterruptIfRunning)70*f585d8a3SJacky Wang   public void cancel(boolean mayInterruptIfRunning) {
71*f585d8a3SJacky Wang     delegate.cancel(mayInterruptIfRunning);
72*f585d8a3SJacky Wang   }
73*f585d8a3SJacky Wang 
74*f585d8a3SJacky Wang   @Override
newDependencyView()75*f585d8a3SJacky Wang   public Producer<T> newDependencyView() {
76*f585d8a3SJacky Wang     return new ProducerView<T>() {
77*f585d8a3SJacky Wang       @Override
78*f585d8a3SJacky Wang       Producer<T> createDelegate() {
79*f585d8a3SJacky Wang         return delegate.newDependencyView();
80*f585d8a3SJacky Wang       }
81*f585d8a3SJacky Wang     };
82*f585d8a3SJacky Wang   }
83*f585d8a3SJacky Wang 
84*f585d8a3SJacky Wang   @Override
85*f585d8a3SJacky Wang   public Producer<T> newEntryPointView(final CancellationListener cancellationListener) {
86*f585d8a3SJacky Wang     return new ProducerView<T>() {
87*f585d8a3SJacky Wang       @Override
88*f585d8a3SJacky Wang       Producer<T> createDelegate() {
89*f585d8a3SJacky Wang         return delegate.newEntryPointView(cancellationListener);
90*f585d8a3SJacky Wang       }
91*f585d8a3SJacky Wang     };
92*f585d8a3SJacky Wang   }
93*f585d8a3SJacky Wang 
94*f585d8a3SJacky Wang   private abstract static class ProducerView<T> implements Producer<T> {
95*f585d8a3SJacky Wang     private final Provider<Producer<T>> delegate =
96*f585d8a3SJacky Wang         DoubleCheck.provider(
97*f585d8a3SJacky Wang             new Provider<Producer<T>>() {
98*f585d8a3SJacky Wang               @Override
99*f585d8a3SJacky Wang               public Producer<T> get() {
100*f585d8a3SJacky Wang                 return createDelegate();
101*f585d8a3SJacky Wang               }
102*f585d8a3SJacky Wang             });
103*f585d8a3SJacky Wang 
104*f585d8a3SJacky Wang     abstract Producer<T> createDelegate();
105*f585d8a3SJacky Wang 
106*f585d8a3SJacky Wang     @Override
107*f585d8a3SJacky Wang     public ListenableFuture<T> get() {
108*f585d8a3SJacky Wang       return delegate.get().get();
109*f585d8a3SJacky Wang     }
110*f585d8a3SJacky Wang   }
111*f585d8a3SJacky Wang }
112