xref: /aosp_15_r20/external/dagger2/java/dagger/internal/ProviderOfLazy.java (revision f585d8a307d0621d6060bd7e80091fdcbf94fe27)
1*f585d8a3SJacky Wang /*
2*f585d8a3SJacky Wang  * Copyright (C) 2016 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.internal;
18*f585d8a3SJacky Wang 
19*f585d8a3SJacky Wang import static dagger.internal.Preconditions.checkNotNull;
20*f585d8a3SJacky Wang import static dagger.internal.Providers.asDaggerProvider;
21*f585d8a3SJacky Wang 
22*f585d8a3SJacky Wang import dagger.Lazy;
23*f585d8a3SJacky Wang 
24*f585d8a3SJacky Wang /**
25*f585d8a3SJacky Wang  * A {@link Provider} of {@link Lazy} instances that each delegate to a given {@link Provider}.
26*f585d8a3SJacky Wang  */
27*f585d8a3SJacky Wang public final class ProviderOfLazy<T> implements Provider<Lazy<T>> {
28*f585d8a3SJacky Wang 
29*f585d8a3SJacky Wang   private final Provider<T> provider;
30*f585d8a3SJacky Wang 
ProviderOfLazy(Provider<T> provider)31*f585d8a3SJacky Wang   private ProviderOfLazy(Provider<T> provider) {
32*f585d8a3SJacky Wang     assert provider != null;
33*f585d8a3SJacky Wang     this.provider = provider;
34*f585d8a3SJacky Wang   }
35*f585d8a3SJacky Wang 
36*f585d8a3SJacky Wang   /**
37*f585d8a3SJacky Wang    * Returns a new instance of {@link Lazy Lazy&lt;T&gt;}, which calls {@link Provider#get()} at
38*f585d8a3SJacky Wang    * most once on the {@link Provider} held by this object.
39*f585d8a3SJacky Wang    */
40*f585d8a3SJacky Wang   @Override
get()41*f585d8a3SJacky Wang   public Lazy<T> get() {
42*f585d8a3SJacky Wang     return DoubleCheck.lazy(provider);
43*f585d8a3SJacky Wang   }
44*f585d8a3SJacky Wang 
45*f585d8a3SJacky Wang   /**
46*f585d8a3SJacky Wang    * Creates a new {@link Provider Provider&lt;Lazy&lt;T&gt;&gt;} that decorates the given
47*f585d8a3SJacky Wang    * {@link Provider}.
48*f585d8a3SJacky Wang    *
49*f585d8a3SJacky Wang    * @see #get()
50*f585d8a3SJacky Wang    */
create(Provider<T> provider)51*f585d8a3SJacky Wang   public static <T> Provider<Lazy<T>> create(Provider<T> provider) {
52*f585d8a3SJacky Wang     return new ProviderOfLazy<T>(checkNotNull(provider));
53*f585d8a3SJacky Wang   }
54*f585d8a3SJacky Wang 
55*f585d8a3SJacky Wang   /**
56*f585d8a3SJacky Wang    * Legacy javax version of the method to support libraries compiled with an older version of
57*f585d8a3SJacky Wang    * Dagger. Do not use directly.
58*f585d8a3SJacky Wang    */
59*f585d8a3SJacky Wang   @Deprecated
create(javax.inject.Provider<T> provider)60*f585d8a3SJacky Wang   public static <T> Provider<Lazy<T>> create(javax.inject.Provider<T> provider) {
61*f585d8a3SJacky Wang     return create(asDaggerProvider(provider));
62*f585d8a3SJacky Wang   }
63*f585d8a3SJacky Wang }
64