1 /*
2  * Copyright (C) 2022 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 package com.android.quicksearchbox
17 
18 import kotlin.collections.HashSet
19 import org.json.JSONException
20 
21 /** Abstract SuggestionExtras supporting flattening to JSON. */
22 abstract class AbstractSuggestionExtras
23 protected constructor(private val mMore: SuggestionExtras?) : SuggestionExtras {
24   @get:Override
25   override val extraColumnNames: Collection<String>
26     get() {
27       val columns: HashSet<String> = HashSet<String>()
28       columns.addAll(doGetExtraColumnNames())
29       if (mMore != null) {
30         columns.addAll(mMore.extraColumnNames)
31       }
32       return columns
33     }
34 
doGetExtraColumnNamesnull35   protected abstract fun doGetExtraColumnNames(): Collection<String>
36   override fun getExtra(columnName: String?): String? {
37     var extra = doGetExtra(columnName)
38     if (extra == null && mMore != null) {
39       extra = mMore.getExtra(columnName)
40     }
41     return extra
42   }
43 
doGetExtranull44   protected abstract fun doGetExtra(columnName: String?): String?
45 
46   @Throws(JSONException::class)
47   override fun toJsonString(): String? {
48     return JsonBackedSuggestionExtras(this).toString()
49   }
50 }
51