1 /* 2 * Copyright (C) 2019 The Android Open Source Project 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 com.android.car.developeroptions.search; 18 19 import android.content.Context; 20 import android.provider.SearchIndexableResource; 21 22 import androidx.annotation.Keep; 23 24 import com.android.settingslib.core.AbstractPreferenceController; 25 26 import java.util.List; 27 28 /** 29 * Interface for classes whose instances can provide data for indexing. 30 * 31 * Classes implementing the Indexable interface must have a static field called 32 * <code>SEARCH_INDEX_DATA_PROVIDER</code>, which is an object implementing the 33 * {@link Indexable.SearchIndexProvider} interface. 34 * 35 * See {@link android.provider.SearchIndexableResource} and {@link SearchIndexableRaw}. 36 */ 37 public interface Indexable { 38 39 interface SearchIndexProvider { 40 /** 41 * Return a list of references for indexing. 42 * 43 * See {@link android.provider.SearchIndexableResource} 44 * 45 * @param context the context. 46 * @param enabled hint telling if the data needs to be considered into the search results 47 * or not. 48 * @return a list of {@link android.provider.SearchIndexableResource} references. 49 * Can be null. 50 */ 51 @Keep getXmlResourcesToIndex(Context context, boolean enabled)52 List<SearchIndexableResource> getXmlResourcesToIndex(Context context, boolean enabled); 53 54 /** 55 * Return a list of raw data for indexing. See {@link SearchIndexableRaw} 56 * 57 * @param context the context. 58 * @param enabled hint telling if the data needs to be considered into the search results 59 * or not. 60 * @return a list of {@link SearchIndexableRaw} references. Can be null. 61 */ 62 @Keep getRawDataToIndex(Context context, boolean enabled)63 List<SearchIndexableRaw> getRawDataToIndex(Context context, boolean enabled); 64 65 /** 66 * Return a list of data keys that cannot be indexed. See {@link SearchIndexableRaw} 67 * 68 * @param context the context. 69 * @return a list of {@link SearchIndexableRaw} references. Can be null. 70 */ 71 @Keep getNonIndexableKeys(Context context)72 List<String> getNonIndexableKeys(Context context); 73 74 /** 75 * @return a list of {@link AbstractPreferenceController} for ResultPayload data during 76 * Indexing. 77 */ 78 @Keep getPreferenceControllers(Context context)79 List<AbstractPreferenceController> getPreferenceControllers(Context context); 80 } 81 } 82