/
SuggestionsListBuilder.java
68 lines (60 loc) · 2.54 KB
/
SuggestionsListBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
* Copyright 2015 LinkedIn Corp. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*/
package com.linkedin.android.spyglass.suggestions.interfaces;
import android.content.Context;
import android.content.res.Resources;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.linkedin.android.spyglass.suggestions.SuggestionsResult;
import java.util.List;
import java.util.Map;
/**
* Interface that defines the list of suggestions to display and how to display them.
*/
public interface SuggestionsListBuilder {
/**
* Create the list of suggestions from the newest {@link SuggestionsResult} received for every bucket. This
* allows you to control the exact order of the suggestions.
*
* @param latestResults newest {@link SuggestionsResult} for every bucket
* @param currentTokenString the most recent token, as typed by the user
*
* @return a list of {@link Suggestible} representing the suggestions in proper order
*/
@NonNull
List<Suggestible> buildSuggestions(final @NonNull Map<String, SuggestionsResult> latestResults,
final @NonNull String currentTokenString);
/**
* Build a basic view for the given object.
*
* @param suggestion object implementing {@link Suggestible} to build a view for
* @param convertView the old view to reuse, if possible
* @param parent parent view
* @param context current {@link android.content.Context} within the adapter
* @param inflater {@link android.view.LayoutInflater} to use
* @param resources {@link android.content.res.Resources} to use
*
* @return a view for the corresponding {@link Suggestible} object in the adapter
*/
@NonNull
View getView(final @NonNull Suggestible suggestion,
@Nullable View convertView,
@Nullable ViewGroup parent,
final @NonNull Context context,
final @NonNull LayoutInflater inflater,
final @NonNull Resources resources);
}