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
69
70
71
72
73
74
75
76
77
78
79
|
/*
* Copyright (C) 2017 The Android Open Source Project
*
* 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.
* See the License for the specific language governing permissions and
* limitations under the License
*/
package com.android.dialer.phonelookup;
import android.support.annotation.NonNull;
import android.telecom.Call;
import com.android.dialer.DialerPhoneNumber;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.util.concurrent.ListenableFuture;
/**
* Provides operations related to retrieving information about phone numbers.
*
* <p>Some operations defined by this interface are generally targeted towards specific use cases;
* for example {@link #isDirty(ImmutableSet)}, {@link #getMostRecentPhoneLookupInfo(ImmutableMap)},
* and {@link #onSuccessfulBulkUpdate()} are generally intended to be used by the call log.
*/
public interface PhoneLookup {
/**
* Returns a future containing a new {@link PhoneLookupInfo} for the provided call.
*
* <p>The returned message should contain populated data for the sub-message corresponding to this
* {@link PhoneLookup}. For example, the CP2 implementation returns a {@link PhoneLookupInfo} with
* the {@link PhoneLookupInfo.Cp2Info} sub-message populated.
*/
ListenableFuture<PhoneLookupInfo> lookup(@NonNull Call call);
/**
* Returns a future which returns true if the information for any of the provided phone numbers
* has changed, usually since {@link #onSuccessfulBulkUpdate()} was last invoked.
*/
ListenableFuture<Boolean> isDirty(ImmutableSet<DialerPhoneNumber> phoneNumbers);
/**
* Get the most recent phone lookup information for this {@link PhoneLookup}. The returned map
* must contain the exact same keys as the provided map. Most implementations will rely on last
* modified timestamps to efficiently only update the data which needs to be updated.
*
* <p>If there are no changes required, it is valid for this method to simply return the provided
* {@code existingInfoMap}.
*
* <p>If there is no longer information associated with a number (for example, a local contact was
* deleted) the returned map should contain an empty {@link PhoneLookupInfo} for that number.
*/
ListenableFuture<ImmutableMap<DialerPhoneNumber, PhoneLookupInfo>> getMostRecentPhoneLookupInfo(
ImmutableMap<DialerPhoneNumber, PhoneLookupInfo> existingInfoMap);
/**
* Populates the sub-message that this {@link PhoneLookup} is responsible for by copying the
* sub-message value from {@code source} to {@code destination}
*/
void copySubMessage(PhoneLookupInfo.Builder destination, PhoneLookupInfo source);
/**
* Called when the results of the {@link #getMostRecentPhoneLookupInfo(ImmutableMap)} have been
* applied by the caller.
*
* <p>Typically implementations will use this to store a "last processed" timestamp so that future
* invocations of {@link #isDirty(ImmutableSet)} and {@link
* #getMostRecentPhoneLookupInfo(ImmutableMap)} can be efficiently implemented.
*/
ListenableFuture<Void> onSuccessfulBulkUpdate();
}
|
