• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2014 The Dagger Authors.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package dagger.producers;
18 
19 import static java.lang.annotation.ElementType.METHOD;
20 import static java.lang.annotation.RetentionPolicy.RUNTIME;
21 
22 import dagger.internal.Beta;
23 import java.lang.annotation.Documented;
24 import java.lang.annotation.Retention;
25 import java.lang.annotation.Target;
26 
27 /**
28  * Annotates methods of a producer module to create a production binding. If the method returns a
29  * {@link com.google.common.util.concurrent.ListenableFuture} or {@link
30  * com.google.common.util.concurrent.FluentFuture}, then the parameter type of the future is bound
31  * to the value that the future produces; otherwise, the return type is bound to the returned value.
32  * The production component will pass dependencies to the method as parameters.
33  *
34  * @since 2.0
35  */
36 @Documented
37 @Target(METHOD)
38 @Retention(RUNTIME)
39 @Beta
40 public @interface Produces {}
41