Merge "System API proxies for the telephony module" (9c7c247d) · Commits · e / os / android_frameworks_base

api/module-lib-current.txt

+45 −0

Original line number	Diff line number	Diff line
		@@ -79,3 +79,48 @@ package android.os {

		}

		package android.timezone {

		public final class CountryTimeZones {
		method @Nullable public android.icu.util.TimeZone getDefaultTimeZone();
		method @Nullable public String getDefaultTimeZoneId();
		method @NonNull public java.util.List<android.timezone.CountryTimeZones.TimeZoneMapping> getEffectiveTimeZoneMappingsAt(long);
		method public boolean hasUtcZone(long);
		method public boolean isDefaultTimeZoneBoosted();
		method public boolean isForCountryCode(@NonNull String);
		method @Nullable public android.timezone.CountryTimeZones.OffsetResult lookupByOffsetWithBias(int, @Nullable Boolean, @Nullable Integer, long, @Nullable android.icu.util.TimeZone);
		}

		public static final class CountryTimeZones.OffsetResult {
		ctor public CountryTimeZones.OffsetResult(@NonNull android.icu.util.TimeZone, boolean);
		method @NonNull public android.icu.util.TimeZone getTimeZone();
		method public boolean isOnlyMatch();
		}

		public static final class CountryTimeZones.TimeZoneMapping {
		method @Nullable public android.icu.util.TimeZone getTimeZone();
		method @NonNull public String getTimeZoneId();
		}

		public class TelephonyLookup {
		method @NonNull public static android.timezone.TelephonyLookup getInstance();
		method @Nullable public android.timezone.TelephonyNetworkFinder getTelephonyNetworkFinder();
		}

		public class TelephonyNetwork {
		method @NonNull public String getCountryIsoCode();
		method @NonNull public String getMcc();
		method @NonNull public String getMnc();
		}

		public class TelephonyNetworkFinder {
		method @Nullable public android.timezone.TelephonyNetwork findNetworkByMccMnc(@NonNull String, @NonNull String);
		}

		public final class TimeZoneFinder {
		method @NonNull public static android.timezone.TimeZoneFinder getInstance();
		method @Nullable public android.timezone.CountryTimeZones lookupCountryTimeZones(@NonNull String);
		}

		}

core/java/android/timezone/CountryTimeZones.java

0 → 100644

+265 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2019 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.timezone;

		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.annotation.SuppressLint;
		import android.annotation.SystemApi;
		import android.icu.util.TimeZone;

		import java.util.ArrayList;
		import java.util.Collections;
		import java.util.List;
		import java.util.Objects;

		/**
		* Information about a country's time zones.
		*
		* @hide
		*/
		@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
		public final class CountryTimeZones {

		/**
		* A mapping to a time zone ID with some associated metadata.
		*
		* @hide
		*/
		@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
		public static final class TimeZoneMapping {

		private libcore.timezone.CountryTimeZones.TimeZoneMapping mDelegate;

		TimeZoneMapping(libcore.timezone.CountryTimeZones.TimeZoneMapping delegate) {
		this.mDelegate = Objects.requireNonNull(delegate);
		}

		/**
		* Returns the ID for this mapping. See also {@link #getTimeZone()} which handles when the
		* ID is unrecognized.
		*/
		@NonNull
		public String getTimeZoneId() {
		return mDelegate.timeZoneId;
		}

		/**
		* Returns a {@link TimeZone} object for this mapping, or {@code null} if the ID is
		* unrecognized.
		*/
		@Nullable
		public TimeZone getTimeZone() {
		return mDelegate.getTimeZone();
		}

		@Override
		public boolean equals(Object o) {
		if (this == o) {
		return true;
		}
		if (o == null \|\| getClass() != o.getClass()) {
		return false;
		}
		TimeZoneMapping that = (TimeZoneMapping) o;
		return this.mDelegate.equals(that.mDelegate);
		}

		@Override
		public int hashCode() {
		return this.mDelegate.hashCode();
		}

		@Override
		public String toString() {
		return mDelegate.toString();
		}
		}

		/**
		* The result of lookup up a time zone using offset information (and possibly more).
		*
		* @hide
		*/
		@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
		public static final class OffsetResult {

		private final TimeZone mTimeZone;
		private final boolean mIsOnlyMatch;

		/** Creates an instance with the supplied information. */
		public OffsetResult(@NonNull TimeZone timeZone, boolean isOnlyMatch) {
		mTimeZone = Objects.requireNonNull(timeZone);
		mIsOnlyMatch = isOnlyMatch;
		}

		/**
		* Returns a time zone that matches the supplied criteria.
		*/
		@NonNull
		public TimeZone getTimeZone() {
		return mTimeZone;
		}

		/**
		* Returns {@code true} if there is only one matching time zone for the supplied criteria.
		*/
		public boolean isOnlyMatch() {
		return mIsOnlyMatch;
		}

		@Override
		public boolean equals(Object o) {
		if (this == o) {
		return true;
		}
		if (o == null \|\| getClass() != o.getClass()) {
		return false;
		}
		OffsetResult that = (OffsetResult) o;
		return mIsOnlyMatch == that.mIsOnlyMatch
		&& mTimeZone.getID().equals(that.mTimeZone.getID());
		}

		@Override
		public int hashCode() {
		return Objects.hash(mTimeZone, mIsOnlyMatch);
		}

		@Override
		public String toString() {
		return "OffsetResult{"
		+ "mTimeZone=" + mTimeZone
		+ ", mIsOnlyMatch=" + mIsOnlyMatch
		+ '}';
		}
		}

		@NonNull
		private final libcore.timezone.CountryTimeZones mDelegate;

		CountryTimeZones(libcore.timezone.CountryTimeZones delegate) {
		mDelegate = delegate;
		}

		/**
		* Returns true if the ISO code for the country is a match for the one specified.
		*/
		public boolean isForCountryCode(@NonNull String countryIso) {
		return mDelegate.isForCountryCode(countryIso);
		}

		/**
		* Returns the default time zone ID for the country. Can return {@code null} in cases when no
		* data is available or the time zone ID was not recognized.
		*/
		@Nullable
		public String getDefaultTimeZoneId() {
		return mDelegate.getDefaultTimeZoneId();
		}

		/**
		* Returns the default time zone for the country. Can return {@code null} in cases when no data
		* is available or the time zone ID was not recognized.
		*/
		@Nullable
		public TimeZone getDefaultTimeZone() {
		return mDelegate.getDefaultTimeZone();
		}

		/**
		* Qualifier for a country's default time zone. {@code true} indicates whether the default
		* would be a good choice <em>generally</em> when there's no other information available.
		*/
		public boolean isDefaultTimeZoneBoosted() {
		return mDelegate.getDefaultTimeZoneBoost();
		}

		/**
		* Returns true if the country has at least one zone that is the same as UTC at the given time.
		*/
		public boolean hasUtcZone(long whenMillis) {
		return mDelegate.hasUtcZone(whenMillis);
		}

		/**
		* Returns a time zone for the country, if there is one, that matches the desired properties. If
		* there are multiple matches and the {@code bias} is one of them then it is returned, otherwise
		* an arbitrary match is returned based on the {@link #getEffectiveTimeZoneMappingsAt(long)}
		* ordering.
		*
		* @param totalOffsetMillis the offset from UTC at {@code whenMillis}
		* @param isDst the Daylight Savings Time state at {@code whenMillis}. {@code true} means DST,
		* {@code false} means not DST, {@code null} means unknown
		* @param dstOffsetMillis the part of {@code totalOffsetMillis} contributed by DST, only used if
		* {@code isDst} is {@code true}. The value can be {@code null} if the DST offset is
		* unknown
		* @param whenMillis the UTC time to match against
		* @param bias the time zone to prefer, can be {@code null}
		*/
		@Nullable
		public OffsetResult lookupByOffsetWithBias(int totalOffsetMillis, @Nullable Boolean isDst,
		@SuppressLint("AutoBoxing") @Nullable Integer dstOffsetMillis, long whenMillis,
		@Nullable TimeZone bias) {
		libcore.timezone.CountryTimeZones.OffsetResult delegateOffsetResult =
		mDelegate.lookupByOffsetWithBias(
		totalOffsetMillis, isDst, dstOffsetMillis, whenMillis, bias);
		return delegateOffsetResult == null ? null :
		new OffsetResult(delegateOffsetResult.mTimeZone, delegateOffsetResult.mOneMatch);
		}

		/**
		* Returns an immutable, ordered list of time zone mappings for the country in an undefined but
		* "priority" order, filtered so that only "effective" time zone IDs are returned. An
		* "effective" time zone is one that differs from another time zone used in the country after
		* {@code whenMillis}. The list can be empty if there were no zones configured or the configured
		* zone IDs were not recognized.
		*/
		@NonNull
		public List<TimeZoneMapping> getEffectiveTimeZoneMappingsAt(long whenMillis) {
		List<libcore.timezone.CountryTimeZones.TimeZoneMapping> delegateList =
		mDelegate.getEffectiveTimeZoneMappingsAt(whenMillis);

		List<TimeZoneMapping> toReturn = new ArrayList<>(delegateList.size());
		for (libcore.timezone.CountryTimeZones.TimeZoneMapping delegateMapping : delegateList) {
		toReturn.add(new TimeZoneMapping(delegateMapping));
		}
		return Collections.unmodifiableList(toReturn);
		}

		@Override
		public boolean equals(Object o) {
		if (this == o) {
		return true;
		}
		if (o == null \|\| getClass() != o.getClass()) {
		return false;
		}
		CountryTimeZones that = (CountryTimeZones) o;
		return mDelegate.equals(that.mDelegate);
		}

		@Override
		public int hashCode() {
		return Objects.hash(mDelegate);
		}

		@Override
		public String toString() {
		return mDelegate.toString();
		}
		}

core/java/android/timezone/TelephonyLookup.java

0 → 100644

+71 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2019 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.timezone;

		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.annotation.SystemApi;

		import com.android.internal.annotations.GuardedBy;

		import java.util.Objects;

		/**
		* A class that can find time zone-related information about telephony networks.
		*
		* @hide
		*/
		@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
		public class TelephonyLookup {

		private static Object sLock = new Object();
		@GuardedBy("sLock")
		private static TelephonyLookup sInstance;

		@NonNull
		private final libcore.timezone.TelephonyLookup mDelegate;

		/**
		* Obtains an instance for use when resolving telephony time zone information. This method never
		* returns {@code null}.
		*/
		@NonNull
		public static TelephonyLookup getInstance() {
		synchronized (sLock) {
		if (sInstance == null) {
		sInstance = new TelephonyLookup(libcore.timezone.TelephonyLookup.getInstance());
		}
		return sInstance;
		}
		}

		private TelephonyLookup(@NonNull libcore.timezone.TelephonyLookup delegate) {
		mDelegate = Objects.requireNonNull(delegate);
		}

		/**
		* Returns an object capable of querying telephony network information. This method can return
		* {@code null} in the event of an error while reading the underlying data files.
		*/
		@Nullable
		public TelephonyNetworkFinder getTelephonyNetworkFinder() {
		libcore.timezone.TelephonyNetworkFinder telephonyNetworkFinderDelegate =
		mDelegate.getTelephonyNetworkFinder();
		return telephonyNetworkFinderDelegate != null
		? new TelephonyNetworkFinder(telephonyNetworkFinderDelegate) : null;
		}
		}

core/java/android/timezone/TelephonyNetwork.java

0 → 100644

+86 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2019 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.timezone;

		import android.annotation.NonNull;
		import android.annotation.SystemApi;

		import java.util.Objects;

		/**
		* Information about a telephony network.
		*
		* @hide
		*/
		@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
		public class TelephonyNetwork {

		@NonNull
		private final libcore.timezone.TelephonyNetwork mDelegate;

		TelephonyNetwork(@NonNull libcore.timezone.TelephonyNetwork delegate) {
		mDelegate = Objects.requireNonNull(delegate);
		}

		/**
		* Returns the Mobile Country Code of the network.
		*/
		@NonNull
		public String getMcc() {
		return mDelegate.getMcc();
		}

		/**
		* Returns the Mobile Network Code of the network.
		*/
		@NonNull
		public String getMnc() {
		return mDelegate.getMnc();
		}

		/**
		* Returns the country in which the network operates as an ISO 3166 alpha-2 (lower case).
		*/
		@NonNull
		public String getCountryIsoCode() {
		return mDelegate.getCountryIsoCode();
		}

		@Override
		public boolean equals(Object o) {
		if (this == o) {
		return true;
		}
		if (o == null \|\| getClass() != o.getClass()) {
		return false;
		}
		TelephonyNetwork that = (TelephonyNetwork) o;
		return mDelegate.equals(that.mDelegate);
		}

		@Override
		public int hashCode() {
		return Objects.hash(mDelegate);
		}

		@Override
		public String toString() {
		return "TelephonyNetwork{"
		+ "mDelegate=" + mDelegate
		+ '}';
		}
		}

core/java/android/timezone/TelephonyNetworkFinder.java

0 → 100644

+55 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2019 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.timezone;

		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.annotation.SystemApi;

		import java.util.Objects;

		/**
		* A class that can find telephony networks loaded via {@link TelephonyLookup}.
		*
		* @hide
		*/
		@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
		public class TelephonyNetworkFinder {

		@NonNull
		private final libcore.timezone.TelephonyNetworkFinder mDelegate;

		TelephonyNetworkFinder(libcore.timezone.TelephonyNetworkFinder delegate) {
		mDelegate = Objects.requireNonNull(delegate);
		}

		/**
		* Returns information held about a specific MCC + MNC combination. It is expected for this
		* method to return {@code null}. Only known, unusual networks will typically have information
		* returned, e.g. if they operate in countries other than the one suggested by their MCC.
		*/
		@Nullable
		public TelephonyNetwork findNetworkByMccMnc(@NonNull String mcc, @NonNull String mnc) {
		Objects.requireNonNull(mcc);
		Objects.requireNonNull(mnc);

		libcore.timezone.TelephonyNetwork telephonyNetworkDelegate =
		mDelegate.findNetworkByMccMnc(mcc, mnc);
		return telephonyNetworkDelegate != null
		? new TelephonyNetwork(telephonyNetworkDelegate) : null;
		}
		}