xref: /aosp_15_r20/external/dagger2/java/dagger/MembersInjector.java (revision f585d8a307d0621d6060bd7e80091fdcbf94fe27)
1 /*
2  * Copyright (C) 2012 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;
18 
19 /**
20  * Injects dependencies into the fields and methods on instances of type {@code T}. Ignores the
21  * presence or absence of an injectable constructor.
22  *
23  * @param <T> type to inject members of
24  *
25  * @since 2.0 (since 1.0 without the provision that {@link #injectMembers} cannot accept
26  *      {@code null})
27  */
28 public interface MembersInjector<T> {
29 
30   /**
31    * Injects dependencies into the fields and methods of {@code instance}. Ignores the presence or
32    * absence of an injectable constructor.
33    *
34    * <p>Whenever a {@link Component} creates an instance, it performs this injection automatically
35    * (after first performing constructor injection), so if you're able to let the component create
36    * all your objects for you, you'll never need to use this method.
37    *
38    * @param instance into which members are to be injected
39    * @throws NullPointerException if {@code instance} is {@code null}
40    */
injectMembers(T instance)41   void injectMembers(T instance);
42 }
43