InternalSanitizer.java revision f5059c39cbf72603c6a28ae9337041ddce5d4899 
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.os.Parcelable;
22import android.view.autofill.AutofillValue;
23
24/**
25 * Superclass of all sanitizers the system understands. As this is not public all public subclasses
26 * have to implement {@link Sanitizer} again.
27 *
28 * @hide
29 */
30@TestApi
31public abstract class InternalSanitizer implements Sanitizer, Parcelable {
32
33    /**
34     * Sanitizes an {@link AutofillValue}.
35     *
36     * @return sanitized value or {@code null} if value could not be sanitized (for example: didn't
37     * match regex, it's an invalid type, regex failed, etc).
38     *
39     * @hide
40     */
41    @Nullable
42    public abstract AutofillValue sanitize(@NonNull AutofillValue value);
43}
44