Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f2bc6ba3 authored by Soonil Nagarkar's avatar Soonil Nagarkar
Browse files

Fix up provider internal/external APIs 

-Encapsulate various fields
-Bring naming in line with API guidelines
-Minor refactoring

Bug: 168621146
Test: manual
Change-Id: I55681a3d84d7833c98569a13a57e6c4f0b728a67
parent 56b327db

location/java/android/location/LocationProvider.java

+15 −15
Original line number Diff line number Diff line
@@ -92,23 +92,23 @@ public class LocationProvider { 
        }



        if (criteria.getAccuracy() != Criteria.NO_REQUIREMENT &&

                criteria.getAccuracy() < properties.mAccuracy) {

                criteria.getAccuracy() < properties.getAccuracy()) {

            return false;

        }

        if (criteria.getPowerRequirement() != Criteria.NO_REQUIREMENT &&

                criteria.getPowerRequirement() < properties.mPowerRequirement) {

                criteria.getPowerRequirement() < properties.getPowerRequirement()) {

            return false;

        }

        if (criteria.isAltitudeRequired() && !properties.mSupportsAltitude) {

        if (criteria.isAltitudeRequired() && !properties.hasAltitudeSupport()) {

            return false;

        }

        if (criteria.isSpeedRequired() && !properties.mSupportsSpeed) {

        if (criteria.isSpeedRequired() && !properties.hasSpeedSupport()) {

            return false;

        }

        if (criteria.isBearingRequired() && !properties.mSupportsBearing) {

        if (criteria.isBearingRequired() && !properties.hasBearingSupport()) {

            return false;

        }

        if (!criteria.isCostAllowed() && properties.mHasMonetaryCost) {

        if (!criteria.isCostAllowed() && properties.hasMonetaryCost()) {

            return false;

        }

        return true;
@@ -119,7 +119,7 @@ public class LocationProvider { 
     * data network (e.g., the Internet), false otherwise.

     */

    public boolean requiresNetwork() {

        return mProperties.mRequiresNetwork;

        return mProperties.hasNetworkRequirement();

    }



    /**
@@ -128,7 +128,7 @@ public class LocationProvider { 
     * otherwise.

     */

    public boolean requiresSatellite() {

        return mProperties.mRequiresSatellite;

        return mProperties.hasSatelliteRequirement();

    }



    /**
@@ -137,7 +137,7 @@ public class LocationProvider { 
     * otherwise.

     */

    public boolean requiresCell() {

        return mProperties.mRequiresCell;

        return mProperties.hasCellRequirement();

    }



    /**
@@ -146,7 +146,7 @@ public class LocationProvider { 
     * each provider to give accurate information.

     */

    public boolean hasMonetaryCost() {

        return mProperties.mHasMonetaryCost;

        return mProperties.hasMonetaryCost();

    }



    /**
@@ -156,7 +156,7 @@ public class LocationProvider { 
     * should return true.

     */

    public boolean supportsAltitude() {

        return mProperties.mSupportsAltitude;

        return mProperties.hasAltitudeSupport();

    }



    /**
@@ -166,7 +166,7 @@ public class LocationProvider { 
     * should return true.

     */

    public boolean supportsSpeed() {

        return mProperties.mSupportsSpeed;

        return mProperties.hasSpeedSupport();

    }



    /**
@@ -176,7 +176,7 @@ public class LocationProvider { 
     * should return true.

     */

    public boolean supportsBearing() {

        return mProperties.mSupportsBearing;

        return mProperties.hasBearingSupport();

    }



    /**
@@ -186,7 +186,7 @@ public class LocationProvider { 
     * constants Criteria.POWER_REQUIREMENT_*.

     */

    public int getPowerRequirement() {

        return mProperties.mPowerRequirement;

        return mProperties.getPowerRequirement();

    }



    /**
@@ -197,6 +197,6 @@ public class LocationProvider { 
     * is returned.

     */

    public int getAccuracy() {

        return mProperties.mAccuracy;

        return mProperties.getAccuracy();

    }

}

location/java/com/android/internal/location/ILocationProvider.aidl

+3 −3
Original line number Diff line number Diff line
@@ -29,12 +29,12 @@ import com.android.internal.location.ProviderRequest; 
 */

interface ILocationProvider {



    @UnsupportedAppUsage

    @UnsupportedAppUsage(maxTargetSdk = 30, publicAlternatives = "{@code Do not use}")

    oneway void setLocationProviderManager(in ILocationProviderManager manager);



    @UnsupportedAppUsage

    @UnsupportedAppUsage(maxTargetSdk = 30, publicAlternatives = "{@code Do not use}")

    oneway void setRequest(in ProviderRequest request, in WorkSource ws);



    @UnsupportedAppUsage

    @UnsupportedAppUsage(maxTargetSdk = 30, publicAlternatives = "{@code Do not use}")

    oneway void sendExtraCommand(String command, in Bundle extras);

}

location/java/com/android/internal/location/ProviderProperties.java

+90 −79
Original line number Diff line number Diff line
@@ -43,86 +43,96 @@ public final class ProviderProperties implements Parcelable { 
    @IntDef({Criteria.ACCURACY_FINE, Criteria.ACCURACY_COARSE})

    public @interface Accuracy {}



    private final boolean mHasNetworkRequirement;

    private final boolean mHasSatelliteRequirement;

    private final boolean mHasCellRequirement;

    private final boolean mHasMonetaryCost;

    private final boolean mHasAltitudeSupport;

    private final boolean mHasSpeedSupport;

    private final boolean mHasBearingSupport;

    private final @PowerRequirement int mPowerRequirement;

    private final @Accuracy int mAccuracy;



    public ProviderProperties(boolean hasNetworkRequirement, boolean hasSatelliteRequirement,

            boolean hasCellRequirement, boolean hasMonetaryCost, boolean hasAltitudeSupport,

            boolean hasSpeedSupport, boolean hasBearingSupport,

            @PowerRequirement int powerRequirement, @Accuracy int accuracy) {

        mHasNetworkRequirement = hasNetworkRequirement;

        mHasSatelliteRequirement = hasSatelliteRequirement;

        mHasCellRequirement = hasCellRequirement;

        mHasMonetaryCost = hasMonetaryCost;

        mHasAltitudeSupport = hasAltitudeSupport;

        mHasSpeedSupport = hasSpeedSupport;

        mHasBearingSupport = hasBearingSupport;

        mPowerRequirement = Preconditions.checkArgumentInRange(powerRequirement, Criteria.POWER_LOW,

                Criteria.POWER_HIGH, "powerRequirement");

        mAccuracy = Preconditions.checkArgumentInRange(accuracy, Criteria.ACCURACY_FINE,

                Criteria.ACCURACY_COARSE, "accuracy");

    }



    /**

     * True if provider requires access to a

     * data network (e.g., the Internet), false otherwise.

     * True if provider requires access to a data network (e.g., the Internet).

     */

    public final boolean mRequiresNetwork;

    public boolean hasNetworkRequirement() {

        return mHasNetworkRequirement;

    }



    /**

     * True if the provider requires access to a

     * satellite-based positioning system (e.g., GPS), false

     * otherwise.

     * True if the provider requires access to a satellite-based positioning system (e.g., GPS).

     */

    public final boolean mRequiresSatellite;

    public boolean hasSatelliteRequirement() {

        return mHasSatelliteRequirement;

    }



    /**

     * True if the provider requires access to an appropriate

     * cellular network (e.g., to make use of cell tower IDs), false

     * otherwise.

     * True if the provider requires access to a cellular network (e.g., for cell tower IDs).

     */

    public final boolean mRequiresCell;

    public boolean hasCellRequirement() {

        return mHasCellRequirement;

    }



    /**

     * True if the use of this provider may result in a

     * monetary charge to the user, false if use is free.  It is up to

     * each provider to give accurate information. Cell (network) usage

     * is not considered monetary cost.

     * True if this provider may result in a monetary charge to the user. Network usage is not

     * considered a monetary cost.

     */

    public final boolean mHasMonetaryCost;

    public boolean hasMonetaryCost() {

        return mHasMonetaryCost;

    }



    /**

     * True if the provider is able to provide altitude

     * information, false otherwise.  A provider that reports altitude

     * under most circumstances but may occasionally not report it

     * should return true.

     * True if the provider is able to provide altitude under at least some conditions.

     */

    public final boolean mSupportsAltitude;

    public boolean hasAltitudeSupport() {

        return mHasAltitudeSupport;

    }



    /**

     * True if the provider is able to provide speed

     * information, false otherwise.  A provider that reports speed

     * under most circumstances but may occasionally not report it

     * should return true.

     * True if the provider is able to provide speed under at least some conditions.

     */

    public final boolean mSupportsSpeed;

    public boolean hasSpeedSupport() {

        return mHasSpeedSupport;

    }



    /**

     * True if the provider is able to provide bearing

     * information, false otherwise.  A provider that reports bearing

     * under most circumstances but may occasionally not report it

     * should return true.

     * True if the provider is able to provide bearing under at least some conditions.

     */

    public final boolean mSupportsBearing;

    public boolean hasBearingSupport() {

        return mHasBearingSupport;

    }



    /**

     * Power requirement for this provider.

     */

    @PowerRequirement

    public final int mPowerRequirement;

    public @PowerRequirement int getPowerRequirement() {

        return mPowerRequirement;

    }



    /**

     * Constant describing the horizontal accuracy returned

     * by this provider.

     */

    @Accuracy

    public final int mAccuracy;



    public ProviderProperties(boolean requiresNetwork, boolean requiresSatellite,

            boolean requiresCell, boolean hasMonetaryCost, boolean supportsAltitude,

            boolean supportsSpeed, boolean supportsBearing, @PowerRequirement int powerRequirement,

            @Accuracy int accuracy) {

        mRequiresNetwork = requiresNetwork;

        mRequiresSatellite = requiresSatellite;

        mRequiresCell = requiresCell;

        mHasMonetaryCost = hasMonetaryCost;

        mSupportsAltitude = supportsAltitude;

        mSupportsSpeed = supportsSpeed;

        mSupportsBearing = supportsBearing;

        mPowerRequirement = Preconditions.checkArgumentInRange(powerRequirement, Criteria.POWER_LOW,

                Criteria.POWER_HIGH, "powerRequirement");

        mAccuracy = Preconditions.checkArgumentInRange(accuracy, Criteria.ACCURACY_FINE,

                Criteria.ACCURACY_COARSE, "accuracy");

    public @Accuracy int getAccuracy() {

        return mAccuracy;

    }



    public static final Parcelable.Creator<ProviderProperties> CREATOR =
@@ -130,13 +140,13 @@ public final class ProviderProperties implements Parcelable { 
                @Override

                public ProviderProperties createFromParcel(Parcel in) {

                    return new ProviderProperties(

                            /* requiresNetwork= */ in.readBoolean(),

                            /* requiresSatellite= */ in.readBoolean(),

                            /* requiresCell= */ in.readBoolean(),

                            /* hasNetworkRequirement= */ in.readBoolean(),

                            /* hasSatelliteRequirement= */ in.readBoolean(),

                            /* hasCellRequirement= */ in.readBoolean(),

                            /* hasMonetaryCost= */ in.readBoolean(),

                            /* supportsAltitude= */ in.readBoolean(),

                            /* supportsSpeed= */ in.readBoolean(),

                            /* supportsBearing= */ in.readBoolean(),

                            /* hasAltitudeSupport= */ in.readBoolean(),

                            /* hasSpeedSupport= */ in.readBoolean(),

                            /* hasBearingSupport= */ in.readBoolean(),

                            /* powerRequirement= */ in.readInt(),

                            /* accuracy= */ in.readInt());

                }
@@ -154,13 +164,13 @@ public final class ProviderProperties implements Parcelable { 


    @Override

    public void writeToParcel(Parcel parcel, int flags) {

        parcel.writeBoolean(mRequiresNetwork);

        parcel.writeBoolean(mRequiresSatellite);

        parcel.writeBoolean(mRequiresCell);

        parcel.writeBoolean(mHasNetworkRequirement);

        parcel.writeBoolean(mHasSatelliteRequirement);

        parcel.writeBoolean(mHasCellRequirement);

        parcel.writeBoolean(mHasMonetaryCost);

        parcel.writeBoolean(mSupportsAltitude);

        parcel.writeBoolean(mSupportsSpeed);

        parcel.writeBoolean(mSupportsBearing);

        parcel.writeBoolean(mHasAltitudeSupport);

        parcel.writeBoolean(mHasSpeedSupport);

        parcel.writeBoolean(mHasBearingSupport);

        parcel.writeInt(mPowerRequirement);

        parcel.writeInt(mAccuracy);

    }
@@ -174,21 +184,22 @@ public final class ProviderProperties implements Parcelable { 
            return false;

        }

        ProviderProperties that = (ProviderProperties) o;

        return mRequiresNetwork == that.mRequiresNetwork

                && mRequiresSatellite == that.mRequiresSatellite

                && mRequiresCell == that.mRequiresCell

        return mHasNetworkRequirement == that.mHasNetworkRequirement

                && mHasSatelliteRequirement == that.mHasSatelliteRequirement

                && mHasCellRequirement == that.mHasCellRequirement

                && mHasMonetaryCost == that.mHasMonetaryCost

                && mSupportsAltitude == that.mSupportsAltitude

                && mSupportsSpeed == that.mSupportsSpeed

                && mSupportsBearing == that.mSupportsBearing

                && mHasAltitudeSupport == that.mHasAltitudeSupport

                && mHasSpeedSupport == that.mHasSpeedSupport

                && mHasBearingSupport == that.mHasBearingSupport

                && mPowerRequirement == that.mPowerRequirement

                && mAccuracy == that.mAccuracy;

    }



    @Override

    public int hashCode() {

        return Objects.hash(mRequiresNetwork, mRequiresSatellite, mRequiresCell, mHasMonetaryCost,

                mSupportsAltitude, mSupportsSpeed, mSupportsBearing, mPowerRequirement, mAccuracy);

        return Objects.hash(mHasNetworkRequirement, mHasSatelliteRequirement, mHasCellRequirement,

                mHasMonetaryCost, mHasAltitudeSupport, mHasSpeedSupport, mHasBearingSupport,

                mPowerRequirement, mAccuracy);

    }



    @Override
@@ -196,15 +207,15 @@ public final class ProviderProperties implements Parcelable { 
        StringBuilder b = new StringBuilder("ProviderProperties[");

        b.append("power=").append(powerToString(mPowerRequirement)).append(", ");

        b.append("accuracy=").append(accuracyToString(mAccuracy));

        if (mRequiresNetwork || mRequiresSatellite || mRequiresCell) {

        if (mHasNetworkRequirement || mHasSatelliteRequirement || mHasCellRequirement) {

            b.append(", requires=");

            if (mRequiresNetwork) {

            if (mHasNetworkRequirement) {

                b.append("network,");

            }

            if (mRequiresSatellite) {

            if (mHasSatelliteRequirement) {

                b.append("satellite,");

            }

            if (mRequiresCell) {

            if (mHasCellRequirement) {

                b.append("cell,");

            }

            b.setLength(b.length() - 1);
@@ -212,15 +223,15 @@ public final class ProviderProperties implements Parcelable { 
        if (mHasMonetaryCost) {

            b.append(", hasMonetaryCost");

        }

        if (mSupportsBearing || mSupportsSpeed || mSupportsAltitude) {

        if (mHasBearingSupport || mHasSpeedSupport || mHasAltitudeSupport) {

            b.append(", supports=[");

            if (mSupportsBearing) {

            if (mHasBearingSupport) {

                b.append("bearing, ");

            }

            if (mSupportsSpeed) {

            if (mHasSpeedSupport) {

                b.append("speed, ");

            }

            if (mSupportsAltitude) {

            if (mHasAltitudeSupport) {

                b.append("altitude, ");

            }

            b.setLength(b.length() - 2);

location/java/com/android/internal/location/ProviderRequest.java

+139 −87

File changed.

Preview size limit exceeded, changes collapsed.

location/lib/api/current.txt

+5 −2
Original line number Diff line number Diff line
@@ -44,14 +44,17 @@ package com.android.location.provider { 
  }



  public final class ProviderPropertiesUnbundled {

    method public static com.android.location.provider.ProviderPropertiesUnbundled create(boolean, boolean, boolean, boolean, boolean, boolean, boolean, int, int);

    method @NonNull public static com.android.location.provider.ProviderPropertiesUnbundled create(boolean, boolean, boolean, boolean, boolean, boolean, boolean, int, int);

  }



  public final class ProviderRequestUnbundled {

    method public long getInterval();

    method public java.util.List<com.android.location.provider.LocationRequestUnbundled> getLocationRequests();

    method @NonNull public java.util.List<com.android.location.provider.LocationRequestUnbundled> getLocationRequests();

    method public boolean getReportLocation();

    method @NonNull @RequiresApi(android.os.Build.VERSION_CODES.S) public android.os.WorkSource getWorkSource();

    method @RequiresApi(android.os.Build.VERSION_CODES.Q) public boolean isLocationSettingsIgnored();

    method @RequiresApi(android.os.Build.VERSION_CODES.S) public boolean isLowPower();

    field public static final long INTERVAL_DISABLED = 9223372036854775807L; // 0x7fffffffffffffffL

  }



}