Merge "New autofill APIs: DateTransformation and DateValueSanitizer." (8fe62bea) · Commits · e / os / android_frameworks_base

api/current.txt

+14 −0

Original line number	Diff line number	Diff line
		@@ -38538,6 +38538,20 @@ package android.service.autofill {
		method public android.service.autofill.Dataset.Builder setValue(android.view.autofill.AutofillId, android.view.autofill.AutofillValue, java.util.regex.Pattern, android.widget.RemoteViews);
		}

		public final class DateTransformation implements android.os.Parcelable android.service.autofill.Transformation {
		ctor public DateTransformation(android.view.autofill.AutofillId, java.text.DateFormat);
		method public int describeContents();
		method public void writeToParcel(android.os.Parcel, int);
		field public static final android.os.Parcelable.Creator<android.service.autofill.DateTransformation> CREATOR;
		}

		public final class DateValueSanitizer implements android.os.Parcelable android.service.autofill.Sanitizer {
		ctor public DateValueSanitizer(java.text.DateFormat);
		method public int describeContents();
		method public void writeToParcel(android.os.Parcel, int);
		field public static final android.os.Parcelable.Creator<android.service.autofill.DateValueSanitizer> CREATOR;
		}

		public final class FieldClassification {
		method public java.util.List<android.service.autofill.FieldClassification.Match> getMatches();
		}

api/test-current.txt

+10 −1

Original line number	Diff line number	Diff line
		@@ -565,6 +565,14 @@ package android.service.autofill {
		method public void apply(android.service.autofill.ValueFinder, android.widget.RemoteViews, int) throws java.lang.Exception;
		}

		public final class DateTransformation extends android.service.autofill.InternalTransformation implements android.os.Parcelable android.service.autofill.Transformation {
		method public void apply(android.service.autofill.ValueFinder, android.widget.RemoteViews, int) throws java.lang.Exception;
		}

		public final class DateValueSanitizer extends android.service.autofill.InternalSanitizer implements android.os.Parcelable android.service.autofill.Sanitizer {
		method public android.view.autofill.AutofillValue sanitize(android.view.autofill.AutofillValue);
		}

		public final class FillResponse implements android.os.Parcelable {
		method public int getFlags();
		}
		@@ -599,7 +607,8 @@ package android.service.autofill {
		}

		public abstract interface ValueFinder {
		method public abstract java.lang.String findByAutofillId(android.view.autofill.AutofillId);
		method public default java.lang.String findByAutofillId(android.view.autofill.AutofillId);
		method public abstract android.view.autofill.AutofillValue findRawValueByAutofillId(android.view.autofill.AutofillId);
		}

		}

core/java/android/service/autofill/DateTransformation.java

0 → 100644

+127 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2018 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 android.service.autofill;

		import static android.view.autofill.Helper.sDebug;

		import android.annotation.NonNull;
		import android.annotation.TestApi;
		import android.os.Parcel;
		import android.os.Parcelable;
		import android.util.Log;
		import android.view.autofill.AutofillId;
		import android.view.autofill.AutofillValue;
		import android.widget.RemoteViews;
		import android.widget.TextView;

		import com.android.internal.util.Preconditions;

		import java.text.DateFormat;
		import java.util.Date;

		/**
		* Replaces a {@link TextView} child of a {@link CustomDescription} with the contents of a field
		* that is expected to have a {@link AutofillValue#forDate(long) date value}.
		*
		* <p>For example, a transformation to display a credit card expiration date as month/year would be:
		*
		* <pre class="prettyprint">
		* new DateTransformation(ccExpDate, new java.text.SimpleDateFormat("MM/yyyy")
		* </pre>
		*/
		public final class DateTransformation extends InternalTransformation implements
		Transformation, Parcelable {
		private static final String TAG = "DateTransformation";

		private final AutofillId mFieldId;
		private final DateFormat mDateFormat;

		/**
		* Creates a new transformation.
		*
		* @param id id of the screen field.
		* @param dateFormat object used to transform the date value of the field to a String.
		*/
		public DateTransformation(@NonNull AutofillId id, @NonNull DateFormat dateFormat) {
		mFieldId = Preconditions.checkNotNull(id);
		mDateFormat = Preconditions.checkNotNull(dateFormat);
		}

		/** @hide */
		@Override
		@TestApi
		public void apply(@NonNull ValueFinder finder, @NonNull RemoteViews parentTemplate,
		int childViewId) throws Exception {
		final AutofillValue value = finder.findRawValueByAutofillId(mFieldId);
		if (value == null) {
		Log.w(TAG, "No value for id " + mFieldId);
		return;
		}
		if (!value.isDate()) {
		Log.w(TAG, "Value for " + mFieldId + " is not date: " + value);
		return;
		}

		try {
		final Date date = new Date(value.getDateValue());
		final String transformed = mDateFormat.format(date);
		if (sDebug) Log.d(TAG, "Transformed " + date + " to " + transformed);

		parentTemplate.setCharSequence(childViewId, "setText", transformed);
		} catch (Exception e) {
		Log.w(TAG, "Could not apply " + mDateFormat + " to " + value + ": " + e);
		}
		}

		/////////////////////////////////////
		// Object "contract" methods. //
		/////////////////////////////////////
		@Override
		public String toString() {
		if (!sDebug) return super.toString();

		return "DateTransformation: [id=" + mFieldId + ", format=" + mDateFormat + "]";
		}

		/////////////////////////////////////
		// Parcelable "contract" methods. //
		/////////////////////////////////////
		@Override
		public int describeContents() {
		return 0;
		}

		@Override
		public void writeToParcel(Parcel parcel, int flags) {
		parcel.writeParcelable(mFieldId, flags);
		parcel.writeSerializable(mDateFormat);
		}

		public static final Parcelable.Creator<DateTransformation> CREATOR =
		new Parcelable.Creator<DateTransformation>() {
		@Override
		public DateTransformation createFromParcel(Parcel parcel) {
		return new DateTransformation(parcel.readParcelable(null),
		(DateFormat) parcel.readSerializable());
		}

		@Override
		public DateTransformation[] newArray(int size) {
		return new DateTransformation[size];
		}
		};
		}

core/java/android/service/autofill/DateValueSanitizer.java

0 → 100644

+123 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2018 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 android.service.autofill;

		import static android.view.autofill.Helper.sDebug;

		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.annotation.TestApi;
		import android.os.Parcel;
		import android.os.Parcelable;
		import android.util.Log;
		import android.view.autofill.AutofillValue;

		import com.android.internal.util.Preconditions;

		import java.text.DateFormat;
		import java.util.Date;

		/**
		* Sanitizes a date {@link AutofillValue} using a {@link DateFormat}.
		*
		* <p>For example, to sanitize a credit card expiration date to just its month and year:
		*
		* <pre class="prettyprint">
		* new DateValueSanitizer(new java.text.SimpleDateFormat("MM/yyyy");
		* </pre>
		*/
		public final class DateValueSanitizer extends InternalSanitizer implements Sanitizer, Parcelable {

		private static final String TAG = "DateValueSanitizer";

		private final DateFormat mDateFormat;

		/**
		* Default constructor.
		*
		* @param dateFormat date format applied to the actual date value of an input field.
		*/
		public DateValueSanitizer(@NonNull DateFormat dateFormat) {
		mDateFormat = Preconditions.checkNotNull(dateFormat);
		}

		/** @hide */
		@Override
		@TestApi
		@Nullable
		public AutofillValue sanitize(@NonNull AutofillValue value) {
		if (value == null) {
		Log.w(TAG, "sanitize() called with null value");
		return null;
		}
		if (!value.isDate()) {
		if (sDebug) Log.d(TAG, value + " is not a date");
		return null;
		}

		try {
		final Date date = new Date(value.getDateValue());

		// First convert it to string
		final String converted = mDateFormat.format(date);
		if (sDebug) Log.d(TAG, "Transformed " + date + " to " + converted);
		// Then parse it back to date
		final Date sanitized = mDateFormat.parse(converted);
		if (sDebug) Log.d(TAG, "Sanitized to " + sanitized);
		return AutofillValue.forDate(sanitized.getTime());
		} catch (Exception e) {
		Log.w(TAG, "Could not apply " + mDateFormat + " to " + value + ": " + e);
		return null;
		}
		}

		/////////////////////////////////////
		// Object "contract" methods. //
		/////////////////////////////////////
		@Override
		public String toString() {
		if (!sDebug) return super.toString();

		return "DateValueSanitizer: [dateFormat=" + mDateFormat + "]";
		}

		/////////////////////////////////////
		// Parcelable "contract" methods. //
		/////////////////////////////////////
		@Override
		public int describeContents() {
		return 0;
		}

		@Override
		public void writeToParcel(Parcel parcel, int flags) {
		parcel.writeSerializable(mDateFormat);
		}

		public static final Parcelable.Creator<DateValueSanitizer> CREATOR =
		new Parcelable.Creator<DateValueSanitizer>() {
		@Override
		public DateValueSanitizer createFromParcel(Parcel parcel) {
		return new DateValueSanitizer((DateFormat) parcel.readSerializable());
		}

		@Override
		public DateValueSanitizer[] newArray(int size) {
		return new DateValueSanitizer[size];
		}
		};
		}

core/java/android/service/autofill/ValueFinder.java

+12 −1

Original line number	Diff line number	Diff line
		@@ -19,6 +19,7 @@ import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.annotation.TestApi;
		import android.view.autofill.AutofillId;
		import android.view.autofill.AutofillValue;

		/**
		* Helper object used to obtain the value of a field in the screen being autofilled.
		@@ -28,8 +29,18 @@ import android.view.autofill.AutofillId;
		@TestApi
		public interface ValueFinder {

		/**
		* Gets the value of a field as String, or {@code null} when not found.
		*/
		@Nullable
		default String findByAutofillId(@NonNull AutofillId id) {
		final AutofillValue value = findRawValueByAutofillId(id);
		return (value == null \|\| !value.isText()) ? null : value.getTextValue().toString();
		}

		/**
		* Gets the value of a field, or {@code null} when not found.
		*/
		@Nullable String findByAutofillId(@NonNull AutofillId id);
		@Nullable
		AutofillValue findRawValueByAutofillId(@NonNull AutofillId id);
		}