Merge "Add javadoc about lifecycles for xml defined Controllers." into sc-dev

This commit is contained in:
Ahaan Ugale
2021-03-09 17:11:53 +00:00
committed by Android (Google) Code Review

View File

@@ -30,6 +30,7 @@ import android.text.TextUtils;
import android.util.Log; import android.util.Log;
import androidx.annotation.Nullable; import androidx.annotation.Nullable;
import androidx.lifecycle.LifecycleObserver;
import androidx.preference.Preference; import androidx.preference.Preference;
import androidx.preference.PreferenceScreen; import androidx.preference.PreferenceScreen;
@@ -38,6 +39,7 @@ import com.android.settings.slices.SettingsSliceProvider;
import com.android.settings.slices.SliceData; import com.android.settings.slices.SliceData;
import com.android.settings.slices.Sliceable; import com.android.settings.slices.Sliceable;
import com.android.settingslib.core.AbstractPreferenceController; import com.android.settingslib.core.AbstractPreferenceController;
import com.android.settingslib.core.lifecycle.Lifecycle;
import com.android.settingslib.search.SearchIndexableRaw; import com.android.settingslib.search.SearchIndexableRaw;
import java.lang.annotation.Retention; import java.lang.annotation.Retention;
@@ -50,6 +52,9 @@ import java.util.List;
* Abstract class to consolidate utility between preference controllers and act as an interface * Abstract class to consolidate utility between preference controllers and act as an interface
* for Slices. The abstract classes that inherit from this class will act as the direct interfaces * for Slices. The abstract classes that inherit from this class will act as the direct interfaces
* for each type when plugging into Slices. * for each type when plugging into Slices.
* <p>
* Controllers defined in xml are automatically {@link Lifecycle#addObserver(LifecycleObserver)
* wired up} to the settings lifecycle if they implement {@link LifecycleObserver}.
*/ */
public abstract class BasePreferenceController extends AbstractPreferenceController implements public abstract class BasePreferenceController extends AbstractPreferenceController implements
Sliceable { Sliceable {