Rename Indexable::getAllPreferenceControllers.

To getPreferenceControllers. "all" is redundant. Then internally, the
old getPreferenceControllers() is renamed to
createPreferenceControllers() to emphasize the controllers are created
from code (versus the ones created from xml).

Bug: 73668763
Test: robotest
Change-Id: Ifec46aefdc2a418031c8e152028b30bdcd396fc7
This commit is contained in:
Fan Zhang
2018-02-22 13:32:32 -08:00
parent 8e6d5ad27e
commit aed8994f6f
47 changed files with 85 additions and 86 deletions

View File

@@ -133,7 +133,8 @@ public class DisplaySettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null);
}
};

View File

@@ -86,7 +86,7 @@ public class VibrationSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildControllers(context, null /* lifecycle */);
}

View File

@@ -91,7 +91,7 @@ public class AppAndNotificationDashboardFragment extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null, null /* host */);
}

View File

@@ -109,7 +109,7 @@ public class DefaultAppSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context);
}

View File

@@ -95,7 +95,7 @@ public class SpecialAccessSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context);
}

View File

@@ -93,7 +93,7 @@ public class ManageAssist extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null /* lifecycle */);
}

View File

@@ -28,7 +28,6 @@ import com.android.settings.connecteddevice.usb.UsbBackend;
import com.android.settings.connecteddevice.usb.UsbModePreferenceController;
import com.android.settings.dashboard.DashboardFragment;
import com.android.settings.nfc.NfcPreferenceController;
import com.android.settings.overlay.FeatureFactory;
import com.android.settings.print.PrintSettingPreferenceController;
import com.android.settings.search.BaseSearchIndexProvider;
import com.android.settingslib.core.AbstractPreferenceController;
@@ -123,7 +122,7 @@ public class AdvancedConnectedDeviceDashboardFragment extends DashboardFragment
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildControllers(context, null /* lifecycle */);
}

View File

@@ -121,7 +121,7 @@ public class UsbDetailsFragment extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
List<AbstractPreferenceController> ret = new ArrayList<>();
ret.addAll(createControllerList(context, new UsbBackend(context), null));

View File

@@ -168,7 +168,7 @@ public class AutomaticStorageManagerSettings extends DashboardFragment
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context);
}

View File

@@ -478,7 +478,7 @@ public class DevelopmentSettingsDashboardFragment extends RestrictedDashboardFra
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context
public List<AbstractPreferenceController> createPreferenceControllers(Context
context) {
return buildPreferenceControllers(context, null /* activity */,
null /* lifecycle */, null /* devOptionsDashboardFragment */,

View File

@@ -158,7 +158,7 @@ public class DeviceInfoSettings extends DashboardFragment implements Indexable {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null /*activity */,
null /* fragment */, null /* lifecycle */);

View File

@@ -58,7 +58,8 @@ import java.util.Arrays;
import java.util.List;
public class StorageDashboardFragment extends DashboardFragment
implements LoaderManager.LoaderCallbacks<SparseArray<StorageAsyncLoader.AppsStorageResult>> {
implements
LoaderManager.LoaderCallbacks<SparseArray<StorageAsyncLoader.AppsStorageResult>> {
private static final String TAG = "StorageDashboardFrag";
private static final int STORAGE_JOB_ID = 0;
private static final int ICON_JOB_ID = 1;
@@ -223,7 +224,8 @@ public class StorageDashboardFragment extends DashboardFragment
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
final StorageManager sm = context.getSystemService(StorageManager.class);
final UserManagerWrapper userManager =
new UserManagerWrapper(context.getSystemService(UserManager.class));
@@ -354,7 +356,8 @@ public class StorageDashboardFragment extends DashboardFragment
}
@Override
public void onLoaderReset(Loader<SparseArray<Drawable>> loader) {}
public void onLoaderReset(Loader<SparseArray<Drawable>> loader) {
}
}
public final class VolumeSizeCallbacks
@@ -369,7 +372,8 @@ public class StorageDashboardFragment extends DashboardFragment
}
@Override
public void onLoaderReset(Loader<PrivateStorageInfo> loader) {}
public void onLoaderReset(Loader<PrivateStorageInfo> loader) {
}
@Override
public void onLoadFinished(

View File

@@ -198,7 +198,7 @@ public class MyDeviceInfoFragment extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null /*activity */,
null /* fragment */, null /* lifecycle */);

View File

@@ -101,7 +101,8 @@ public class AmbientDisplaySettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null,
new AmbientDisplayConfiguration(context), null, null);
}

View File

@@ -137,18 +137,18 @@ public class DreamSettings extends DashboardFragment {
public static final SearchIndexProvider SEARCH_INDEX_DATA_PROVIDER
= new BaseSearchIndexProvider() {
@Override
public List<SearchIndexableResource> getXmlResourcesToIndex(
Context context, boolean enabled) {
final SearchIndexableResource sir = new SearchIndexableResource(context);
sir.xmlResId = R.xml.dream_fragment_overview;
return Arrays.asList(sir);
}
@Override
public List<SearchIndexableResource> getXmlResourcesToIndex(
Context context, boolean enabled) {
final SearchIndexableResource sir = new SearchIndexableResource(context);
sir.xmlResId = R.xml.dream_fragment_overview;
return Arrays.asList(sir);
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
return buildPreferenceControllers(context);
}
};
@Override
public List<AbstractPreferenceController> createPreferenceControllers(Context context) {
return buildPreferenceControllers(context);
}
};
}

View File

@@ -112,7 +112,7 @@ public class EnterprisePrivacySettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, false /* async */);
}

View File

@@ -99,7 +99,7 @@ public class SmartBatterySettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null, null);
}

View File

@@ -18,14 +18,9 @@ package com.android.settings.fuelgauge.batterysaver;
import android.content.Context;
import android.os.Bundle;
import android.os.PowerManager;
import android.provider.SearchIndexableResource;
import android.provider.Settings.Global;
import android.support.annotation.VisibleForTesting;
import android.util.Log;
import com.android.internal.logging.nano.MetricsProto.MetricsEvent;
import com.android.internal.util.ArrayUtils;
import com.android.settings.R;
import com.android.settings.dashboard.DashboardFragment;
import com.android.settings.search.BaseSearchIndexProvider;
@@ -96,7 +91,8 @@ public class BatterySaverSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null);
}
};

View File

@@ -75,7 +75,7 @@ public class AssistGestureSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null /* lifecycle */);
}

View File

@@ -89,7 +89,8 @@ public class DoubleTapPowerSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null /* lifecycle */);
}
};

View File

@@ -97,7 +97,8 @@ public class DoubleTapScreenSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null /* lifecycle */);
}
};

View File

@@ -88,7 +88,7 @@ public class DoubleTwistGestureSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(Context context) {
return buildPreferenceControllers(context, null /* lifecycle */);
}
};

View File

@@ -100,7 +100,7 @@ public class GestureSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null,
new AmbientDisplayConfiguration(context));

View File

@@ -96,7 +96,8 @@ public class PickupGestureSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null /* lifecycle */);
}
};

View File

@@ -89,7 +89,8 @@ public class SwipeToNotificationSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null /* lifecycle */);
}
};

View File

@@ -21,7 +21,6 @@ import android.content.ComponentName;
import android.content.ContentResolver;
import android.content.Context;
import android.content.pm.PackageManager;
import android.os.Bundle;
import android.provider.SearchIndexableResource;
import android.provider.Settings;
import android.speech.tts.TtsEngines;
@@ -188,7 +187,7 @@ public class LanguageAndInputSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null);
}

View File

@@ -178,7 +178,7 @@ public class LocationSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context
public List<AbstractPreferenceController> createPreferenceControllers(Context
context) {
return buildPreferenceControllers(context, null /* fragment */,
null /* lifecycle */);

View File

@@ -77,7 +77,7 @@ public class ScanningSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context
public List<AbstractPreferenceController> createPreferenceControllers(Context
context) {
return buildPreferenceControllers(context);
}

View File

@@ -230,7 +230,7 @@ public class NetworkDashboardFragment extends DashboardFragment implements
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context
public List<AbstractPreferenceController> createPreferenceControllers(Context
context) {
return buildPreferenceControllers(context, null /* lifecycle */,
null /* metricsFeatureProvider */, null /* fragment */,

View File

@@ -165,7 +165,7 @@ public class ConfigureNotificationSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null, null, null);
}

View File

@@ -255,7 +255,8 @@ public class SoundSettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null /* fragment */,
null /* callback */, null /* lifecycle */);
}

View File

@@ -98,7 +98,7 @@ public class ZenModeAutomationSettings extends ZenModeSettingsBase {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null, null, null);
}

View File

@@ -97,7 +97,7 @@ public class ZenModeBehaviorSettings extends ZenModeSettingsBase implements Inde
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(Context context) {
return buildPreferenceControllers(context, null);
}
};

View File

@@ -230,7 +230,7 @@ public class ZenModeSettings extends ZenModeSettingsBase {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context
public List<AbstractPreferenceController> createPreferenceControllers(Context
context) {
return buildPreferenceControllers(context, null, null);
}

View File

@@ -67,7 +67,7 @@ public class BaseSearchIndexProvider implements Indexable.SearchIndexProvider {
// Entire page should be suppressed, mark all keys from this page as non-indexable.
return getNonIndexableKeysFromXml(context);
}
final List<AbstractPreferenceController> controllers = getAllPreferenceControllers(context);
final List<AbstractPreferenceController> controllers = getPreferenceControllers(context);
if (controllers != null && !controllers.isEmpty()) {
final List<String> nonIndexableKeys = new ArrayList<>();
for (AbstractPreferenceController controller : controllers) {
@@ -89,9 +89,9 @@ public class BaseSearchIndexProvider implements Indexable.SearchIndexProvider {
}
@Override
public List<AbstractPreferenceController> getAllPreferenceControllers(Context context) {
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
final List<AbstractPreferenceController> controllersFromCode =
getPreferenceControllers(context);
createPreferenceControllers(context);
final List<SearchIndexableResource> res = getXmlResourcesToIndex(context, true);
if (res == null || res.isEmpty()) {
return controllersFromCode;
@@ -111,7 +111,12 @@ public class BaseSearchIndexProvider implements Indexable.SearchIndexProvider {
return allControllers;
}
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
/**
* Creates a list of {@link AbstractPreferenceController} programatically.
* <p/>
* This list should create controllers that are not defined in xml as a Slice controller.
*/
public List<AbstractPreferenceController> createPreferenceControllers(Context context) {
return null;
}

View File

@@ -96,7 +96,7 @@ public class DatabaseIndexingUtils {
final Indexable.SearchIndexProvider provider = getSearchIndexProvider(clazz);
final List<AbstractPreferenceController> controllers =
provider.getAllPreferenceControllers(context);
provider.getPreferenceControllers(context);
if (controllers == null) {
return map;

View File

@@ -31,7 +31,6 @@ import java.util.List;
* {@link Indexable.SearchIndexProvider} interface.
*
* See {@link android.provider.SearchIndexableResource} and {@link SearchIndexableRaw}.
*
*/
public interface Indexable {
@@ -41,12 +40,11 @@ public interface Indexable {
*
* See {@link android.provider.SearchIndexableResource}
*
*
* @param context the context.
* @param enabled hint telling if the data needs to be considered into the search results
* or not.
* @return a list of {@link android.provider.SearchIndexableResource} references.
* Can be null.
* Can be null.
*/
List<SearchIndexableResource> getXmlResourcesToIndex(Context context, boolean enabled);
@@ -69,12 +67,9 @@ public interface Indexable {
List<String> getNonIndexableKeys(Context context);
/**
* @param context
* @return a list of {@link AbstractPreferenceController} for ResultPayload data during
* Indexing.
*
* TODO(zhfan): name is confusing(too similar to getPreferenceControllers). Rename both.
*/
List<AbstractPreferenceController> getAllPreferenceControllers(Context context);
List<AbstractPreferenceController> getPreferenceControllers(Context context);
}
}

View File

@@ -101,7 +101,7 @@ public class EncryptionAndCredential extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(Context context) {
return buildPreferenceControllers(context, null /* lifecycle */);
}

View File

@@ -114,7 +114,7 @@ public class LockscreenDashboardFragment extends DashboardFragment
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
final List<AbstractPreferenceController> controllers = new ArrayList<>();
controllers.add(new LockScreenNotificationPreferenceController(context));

View File

@@ -164,7 +164,7 @@ public class SecuritySettings extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context
public List<AbstractPreferenceController> createPreferenceControllers(Context
context) {
return buildPreferenceControllers(context, null /* lifecycle */,
null /* host*/);

View File

@@ -99,7 +99,7 @@ public class ScreenLockSettings extends DashboardFragment
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null /* parent */,
null /* lifecycle */, new LockPatternUtils(context));

View File

@@ -79,7 +79,8 @@ public class ResetDashboardFragment extends DashboardFragment {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(
Context context) {
return buildPreferenceControllers(context, null /* lifecycle */);
}
};

View File

@@ -50,7 +50,7 @@ public class DashboardFragmentSearchIndexProviderInspector {
final List<AbstractPreferenceController> controllersFromSearchIndexProvider;
final List<AbstractPreferenceController> controllersFromFragment;
try {
controllersFromSearchIndexProvider = provider.getAllPreferenceControllers(context);
controllersFromSearchIndexProvider = provider.getPreferenceControllers(context);
} catch (Throwable e) {
// Can't do much with exception, assume the test passed.
return true;

View File

@@ -98,7 +98,7 @@ public final class EnterprisePrivacySettingsTest {
@Test
public void getSearchIndexProviderPreferenceControllers() throws Exception {
final List<AbstractPreferenceController> controllers
= EnterprisePrivacySettings.SEARCH_INDEX_DATA_PROVIDER.getAllPreferenceControllers(
= EnterprisePrivacySettings.SEARCH_INDEX_DATA_PROVIDER.getPreferenceControllers(
ShadowApplication.getInstance().getApplicationContext());
verifyPreferenceControllers(controllers);
}

View File

@@ -85,7 +85,7 @@ public class BaseSearchIndexProviderTest {
public void getNonIndexableKeys_preferenceIsAvailable_shouldReturnEmptyList() {
List<AbstractPreferenceController> controllers = new ArrayList<>();
controllers.add(new AvailablePreferenceController(mContext));
doReturn(controllers).when(mIndexProvider).getPreferenceControllers(mContext);
doReturn(controllers).when(mIndexProvider).createPreferenceControllers(mContext);
assertThat(mIndexProvider.getNonIndexableKeys(mContext)).isEqualTo(Collections.EMPTY_LIST);
}
@@ -104,7 +104,7 @@ public class BaseSearchIndexProviderTest {
}
@Override
public List<AbstractPreferenceController> getPreferenceControllers(Context context) {
public List<AbstractPreferenceController> createPreferenceControllers(Context context) {
final List<AbstractPreferenceController> controllersFromCode = new ArrayList<>();
controllersFromCode.add(new BasePreferenceController(mContext, "TEST_KEY") {
@Override
@@ -117,7 +117,7 @@ public class BaseSearchIndexProviderTest {
};
final List<AbstractPreferenceController> controllers =
provider.getAllPreferenceControllers(mContext);
provider.getPreferenceControllers(mContext);
assertThat(controllers).hasSize(3);
}
@@ -143,7 +143,7 @@ public class BaseSearchIndexProviderTest {
public void getNonIndexableKeys_preferenceIsNotAvailable_shouldReturnKey() {
List<AbstractPreferenceController> controllers = new ArrayList<>();
controllers.add(new NotAvailablePreferenceController(mContext));
doReturn(controllers).when(mIndexProvider).getPreferenceControllers(mContext);
doReturn(controllers).when(mIndexProvider).createPreferenceControllers(mContext);
assertThat(mIndexProvider.getNonIndexableKeys(mContext)).contains(TEST_PREF_KEY);
}

View File

@@ -116,11 +116,5 @@ public class FakeSettingsFragment extends DashboardFragment {
keys.add("pref_key_3");
return keys;
}
@Override
public List<AbstractPreferenceController>
getPreferenceControllers(Context context) {
return null;
}
};
}

View File

@@ -20,7 +20,6 @@ import static junit.framework.Assert.fail;
import android.content.Context;
import android.platform.test.annotations.Presubmit;
import android.provider.SearchIndexableResource;
import android.support.test.InstrumentationRegistry;
import android.support.test.filters.MediumTest;
import android.support.test.runner.AndroidJUnit4;
@@ -67,7 +66,7 @@ public class PreferenceControllerContractTest {
}
final List<AbstractPreferenceController> controllers =
provider.getAllPreferenceControllers(mContext);
provider.getPreferenceControllers(mContext);
if (controllers == null) {
continue;
}