chrome/android/java/src/org/chromium/chrome/browser/autofill/PhoneNumberUtil.java

// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package org.chromium.chrome.browser.autofill;

import android.support.annotation.Nullable;
import android.text.Editable;
import android.text.TextWatcher;

import org.chromium.base.annotations.JNINamespace;

/**
 * Android wrapper of i18n::phonenumbers::PhoneNumberUtil which provides convenient methods to
 * format and validate phone number.
 */
@JNINamespace("autofill")
public class PhoneNumberUtil {
    // Avoid instantiation by accident.
    private PhoneNumberUtil() {}

    /**
     * TextWatcher to watch phone number changes so as to format it based on country code.
     */
    public static class CountryAwareFormatTextWatcher implements TextWatcher {
        /** Indicates the change was caused by ourselves. */
        private boolean mSelfChange;
        @Nullable
        private String mCountryCode;

        /**
         * Updates the country code used to format phone numbers.
         *
         * @param countryCode The given country code.
         */
        public void setCountryCode(@Nullable String countryCode) {
            mCountryCode = countryCode;
        }

        @Override
        public void afterTextChanged(Editable s) {
            if (mSelfChange) return;

            String formattedNumber = formatForDisplay(s.toString(), mCountryCode);
            mSelfChange = true;
            s.replace(0, s.length(), formattedNumber, 0, formattedNumber.length());
            mSelfChange = false;
        }

        @Override
        public void beforeTextChanged(CharSequence s, int start, int count, int after) {}

        @Override
        public void onTextChanged(CharSequence s, int start, int before, int count) {}
    }

    /**
     * Formats the given phone number in INTERNATIONAL format
     * [i18n::phonenumbers::PhoneNumberUtil::PhoneNumberFormat::INTERNATIONAL] based
     * on region code, returning the original number if no formatting can be made.
     * For example, the number of the Google Zürich office will be formatted as
     * "+41 44 668 1800" in INTERNATIONAL format.
     *
     * Note that the region code is from the given phone number if it starts with
     * '+', otherwise the region code is deduced from the given country code or
     * from application locale if the given country code is null.
     *
     * @param phoneNumber The given phone number.
     * @param countryCode The given country code.
     * @return Formatted phone number.
     */
    public static String formatForDisplay(String phoneNumber, @Nullable String countryCode) {
        return nativeFormatForDisplay(phoneNumber, countryCode);
    }

    /**
     * Formats the given phone number in E.164 format as specified in the Payment Request spec
     * (https://w3c.github.io/browser-payment-api/#paymentrequest-updated-algorithm)
     * [i18n::phonenumbers::PhoneNumberUtil::PhoneNumberFormat::E164], returning the original number
     * if no formatting can be made. For example, the number of the Google Zürich office will be
     * formatted as "+41446681800" in E.164 format.
     *
     * @param phoneNumber The given phone number.
     * @return Formatted phone number.
     */
    public static String formatForResponse(String phoneNumber) {
        return nativeFormatForResponse(phoneNumber);
    }

    /**
     * Checks whether the given phone number is a possible number according to
     * region code.
     * The region code is from the given phone number if it starts with '+',
     * otherwise the region code is deduced from the given country code or from
     * application locale if the given country code is null.
     *
     * @param phoneNumber The given phone number.
     * @param countryCode The given country code.
     *
     * @return True if the given number is a possible number, otherwise return false.
     */
    public static boolean isPossibleNumber(String phoneNumber, @Nullable String countryCode) {
        return nativeIsPossibleNumber(phoneNumber, countryCode);
    }

    private static native String nativeFormatForDisplay(String phoneNumber, String countryCode);
    private static native String nativeFormatForResponse(String phoneNumber);
    private static native boolean nativeIsPossibleNumber(String phoneNumber, String countryCode);
}