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

@@ -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);
}
}