1*f585d8a3SJacky Wang /* 2*f585d8a3SJacky Wang * Copyright (C) 2017 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.android; 18*f585d8a3SJacky Wang 19*f585d8a3SJacky Wang import android.content.BroadcastReceiver; 20*f585d8a3SJacky Wang import android.content.Context; 21*f585d8a3SJacky Wang import android.content.Intent; 22*f585d8a3SJacky Wang import androidx.annotation.CallSuper; 23*f585d8a3SJacky Wang import dagger.internal.Beta; 24*f585d8a3SJacky Wang 25*f585d8a3SJacky Wang /** 26*f585d8a3SJacky Wang * A {@link BroadcastReceiver} that injects its members in every call to {@link #onReceive(Context, 27*f585d8a3SJacky Wang * Intent)}. 28*f585d8a3SJacky Wang * 29*f585d8a3SJacky Wang * <p>This class should only be used for {@link BroadcastReceiver}s that are declared in an {@code 30*f585d8a3SJacky Wang * AndroidManifest.xml}. If, instead, the {@link BroadcastReceiver} is created in code, prefer 31*f585d8a3SJacky Wang * constructor injection. 32*f585d8a3SJacky Wang * 33*f585d8a3SJacky Wang * <p>Note: this class is <em>not thread safe</em> and should not be used with multiple {@link 34*f585d8a3SJacky Wang * android.os.Handler}s in calls to {@link Context#registerReceiver(BroadcastReceiver, 35*f585d8a3SJacky Wang * android.content.IntentFilter, String, android.os.Handler)}. Injection is performed on each 36*f585d8a3SJacky Wang * invocation to {@link #onReceive(Context, Intent)} which could result in inconsistent views of 37*f585d8a3SJacky Wang * injected dependencies across threads. 38*f585d8a3SJacky Wang * 39*f585d8a3SJacky Wang * <p>Subclasses should override {@link #onReceive(Context, Intent)} and call {@code 40*f585d8a3SJacky Wang * super.onReceive(context, intent)} immediately to ensure injection is performed immediately. 41*f585d8a3SJacky Wang */ 42*f585d8a3SJacky Wang @Beta 43*f585d8a3SJacky Wang public abstract class DaggerBroadcastReceiver extends BroadcastReceiver { 44*f585d8a3SJacky Wang @CallSuper 45*f585d8a3SJacky Wang @Override onReceive(Context context, Intent intent)46*f585d8a3SJacky Wang public void onReceive(Context context, Intent intent) { 47*f585d8a3SJacky Wang AndroidInjection.inject(this, context); 48*f585d8a3SJacky Wang } 49*f585d8a3SJacky Wang } 50