1/*
2 * Copyright (C) 2017 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 */
16package android.service.autofill;
17
18import android.annotation.NonNull;
19import android.annotation.Nullable;
20import android.annotation.TestApi;
21import android.view.autofill.AutofillId;
22import android.view.autofill.AutofillValue;
23
24/**
25 * Helper object used to obtain the value of a field in the screen being autofilled.
26 *
27 * @hide
28 */
29@TestApi
30public interface ValueFinder {
31
32    /**
33     * Gets the value of a field as String, or {@code null} when not found.
34     */
35    @Nullable
36    default String findByAutofillId(@NonNull AutofillId id) {
37        final AutofillValue value = findRawValueByAutofillId(id);
38        return (value == null || !value.isText()) ? null : value.getTextValue().toString();
39    }
40
41    /**
42     * Gets the value of a field, or {@code null} when not found.
43     */
44    @Nullable
45    AutofillValue findRawValueByAutofillId(@NonNull AutofillId id);
46}
47