• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2020 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.assisted;
18 
19 import static java.lang.annotation.ElementType.TYPE;
20 import static java.lang.annotation.RetentionPolicy.RUNTIME;
21 
22 import java.lang.annotation.Documented;
23 import java.lang.annotation.Retention;
24 import java.lang.annotation.Target;
25 
26 /**
27  * Annotates an abstract class or interface used to create an instance of a type via an {@link
28  * AssistedInject} constructor.
29  *
30  * <p>An {@link AssistedFactory}-annotated type must obey the following constraints:
31  *
32  * <ul>
33  *   <li>The type must be an abstract class or interface,
34  *   <li>The type must contain exactly one abstract, non-default method whose
35  *       <ul>
36  *         <li>return type must exactly match the type of an assisted injection type, and
37  *         <li>parameters must match the exact list of {@link Assisted} parameters in the assisted
38  *             injection type's constructor (and in the same order).
39  *       </ul>
40  * </ul>
41  *
42  * See {@link AssistedInject}
43  */
44 @Documented
45 @Retention(RUNTIME)
46 @Target(TYPE)
47 public @interface AssistedFactory {}
48