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

Commit 3796ab1b authored by gomo's avatar gomo
Browse files

Bluesky API council review 

Making method names clearer and adding more annotations.

Bug: 124882841
Test: Current Tests Pass.
Change-Id: Ic36f9ac6e69280f3efa9f812fee1ff6e4e4b1773
parent 0f1f043f

api/system-current.txt

+12 −12
Original line number Diff line number Diff line
@@ -3036,21 +3036,21 @@ package android.location { 
    method public double getHorizontalPositionUncertaintyMeters();

    method public double getLatitudeDegrees();

    method public double getLongitudeDegrees();

    method @Nullable public java.util.List<android.location.GnssSingleSatCorrection> getSingleSatCorrectionList();

    method @Nullable public java.util.List<android.location.GnssSingleSatCorrection> getSingleSatelliteCorrectionList();

    method public long getToaGpsNanosecondsOfWeek();

    method public double getVerticalPositionUncertaintyMeters();

    method public void writeToParcel(android.os.Parcel, int);

    field public static final android.os.Parcelable.Creator<android.location.GnssMeasurementCorrections> CREATOR;

  }













  public static class GnssMeasurementCorrections.Builder {













  public static final class GnssMeasurementCorrections.Builder {















    ctor public GnssMeasurementCorrections.Builder();















    method public android.location.GnssMeasurementCorrections build();















    method public android.location.GnssMeasurementCorrections.Builder setAltitudeMeters(double);















    method public android.location.GnssMeasurementCorrections.Builder setHorizontalPositionUncertaintyMeters(double);















    method public android.location.GnssMeasurementCorrections.Builder setLatitudeDegrees(double);















    method public android.location.GnssMeasurementCorrections.Builder setLongitudeDegrees(double);













    method public android.location.GnssMeasurementCorrections.Builder setSingleSatCorrectionList(@Nullable java.util.List<android.location.GnssSingleSatCorrection>);













    method public android.location.GnssMeasurementCorrections.Builder setSingleSatelliteCorrectionList(@Nullable java.util.List<android.location.GnssSingleSatCorrection>);















    method public android.location.GnssMeasurementCorrections.Builder setToaGpsNanosecondsOfWeek(long);















    method public android.location.GnssMeasurementCorrections.Builder setVerticalPositionUncertaintyMeters(double);















  }









@@ -3065,7 +3065,7 @@ package android.location {













    field public static final android.os.Parcelable.Creator<android.location.GnssReflectingPlane> CREATOR;















  }



























  public static class GnssReflectingPlane.Builder {













  public static final class GnssReflectingPlane.Builder {















    ctor public GnssReflectingPlane.Builder();















    method public android.location.GnssReflectingPlane build();















    method public android.location.GnssReflectingPlane.Builder setAltitudeMeters(double);









@@ -3080,14 +3080,14 @@ package android.location {













    method public int getConstellationType();















    method public float getExcessPathLengthMeters();















    method public float getExcessPathLengthUncertaintyMeters();













    method @FloatRange(from=0.0f, to=1.0f) public float getProbSatIsLos();













    method @FloatRange(from=0.0f, to=1.0f) public float getProbabilityLineOfSight();















    method @Nullable public android.location.GnssReflectingPlane getReflectingPlane();













    method public int getSatId();













    method public int getSingleSatCorrectionFlags();













    method public int getSatelliteId();













    method public int getSingleSatelliteCorrectionFlags();















    method public boolean hasExcessPathLength();















    method public boolean hasExcessPathLengthUncertainty();















    method public boolean hasReflectingPlane();













    method public boolean hasSatelliteLineOfSight();













    method public boolean hasValidSatelliteLineOfSight();















    method public void writeToParcel(android.os.Parcel, int);















    field public static final android.os.Parcelable.Creator<android.location.GnssSingleSatCorrection> CREATOR;















    field public static final int HAS_EXCESS_PATH_LENGTH_MASK = 2; // 0x2









@@ -3096,17 +3096,17 @@ package android.location {













    field public static final int HAS_REFLECTING_PLANE_MASK = 8; // 0x8















  }



























  public static class GnssSingleSatCorrection.Builder {













  public static final class GnssSingleSatCorrection.Builder {















    ctor public GnssSingleSatCorrection.Builder();















    method public android.location.GnssSingleSatCorrection build();















    method public android.location.GnssSingleSatCorrection.Builder setCarrierFrequencyHz(float);















    method public android.location.GnssSingleSatCorrection.Builder setConstellationType(int);















    method public android.location.GnssSingleSatCorrection.Builder setExcessPathLengthMeters(float);















    method public android.location.GnssSingleSatCorrection.Builder setExcessPathLengthUncertaintyMeters(float);













    method public android.location.GnssSingleSatCorrection.Builder setProbSatIsLos(@FloatRange(from=0.0f, to=1.0f) float);













    method public android.location.GnssSingleSatCorrection.Builder setProbabilityLineOfSight(@FloatRange(from=0.0f, to=1.0f) float);















    method public android.location.GnssSingleSatCorrection.Builder setReflectingPlane(android.location.GnssReflectingPlane);













    method public android.location.GnssSingleSatCorrection.Builder setSatId(int);













    method public android.location.GnssSingleSatCorrection.Builder setSingleSatCorrectionFlags(int);













    method public android.location.GnssSingleSatCorrection.Builder setSatelliteId(int);













    method public android.location.GnssSingleSatCorrection.Builder setSingleSatelliteCorrectionFlags(int);















  }





























  public class GpsClock implements android.os.Parcelable {

































location/java/android/location/GnssMeasurementCorrections.java



+5
−5




























Original line number
Diff line number
Diff line








@@ -124,7 +124,7 @@ public final class GnssMeasurementCorrections implements Parcelable {













     * Gets a set of {@link GnssSingleSatCorrection} each containing measurement corrections for a















     * satellite in view















     */













    public @Nullable List<GnssSingleSatCorrection> getSingleSatCorrectionList() {













    public @Nullable List<GnssSingleSatCorrection> getSingleSatelliteCorrectionList() {















        return mSingleSatCorrectionList;















    }

























@@ -137,7 +137,7 @@ public final class GnssMeasurementCorrections implements Parcelable {













            new Creator<GnssMeasurementCorrections>() {















                @Override















                public GnssMeasurementCorrections createFromParcel(Parcel parcel) {













                    GnssMeasurementCorrections.Builder gnssMeasurementCorrectons =













                    final GnssMeasurementCorrections.Builder gnssMeasurementCorrectons =















                            new Builder()















                                    .setLatitudeDegrees(parcel.readDouble())















                                    .setLongitudeDegrees(parcel.readDouble())









@@ -147,7 +147,7 @@ public final class GnssMeasurementCorrections implements Parcelable {













                                    .setToaGpsNanosecondsOfWeek(parcel.readLong());















                    List<GnssSingleSatCorrection> singleSatCorrectionList = new ArrayList<>();















                    parcel.readTypedList(singleSatCorrectionList, GnssSingleSatCorrection.CREATOR);













                    gnssMeasurementCorrectons.setSingleSatCorrectionList(













                    gnssMeasurementCorrectons.setSingleSatelliteCorrectionList(















                            singleSatCorrectionList.isEmpty() ? null : singleSatCorrectionList);















                    return gnssMeasurementCorrectons.build();















                }










@@ -188,7 +188,7 @@ public final class GnssMeasurementCorrections implements Parcelable {













    }































    /** Builder for {@link GnssMeasurementCorrections} */













    public static class Builder {













    public static final class Builder {















        /**















         * For documentation of below fields, see corresponding fields in {@link















         * GnssMeasurementCorrections}.










@@ -253,7 +253,7 @@ public final class GnssMeasurementCorrections implements Parcelable {













         * Sets a the list of {@link GnssSingleSatCorrection} containing measurement corrections for















         * a satellite in view















         */













        public Builder setSingleSatCorrectionList(













        public Builder setSingleSatelliteCorrectionList(















                @Nullable List<GnssSingleSatCorrection> singleSatCorrectionList) {















            if (singleSatCorrectionList == null) {















                mSingleSatCorrectionList = null;

































location/java/android/location/GnssReflectingPlane.java



+1
−1




























Original line number
Diff line number
Diff line








@@ -116,7 +116,7 @@ public final class GnssReflectingPlane implements Parcelable {













    }































    /** Builder for {@link GnssReflectingPlane} */













    public static class Builder {













    public static final class Builder {















        /** For documentation, see corresponding fields in {@link GnssReflectingPlane}. */















        private double mLatitudeDegrees;

















































location/java/android/location/GnssSingleSatCorrection.java



+16
−14




























Original line number
Diff line number
Diff line








@@ -60,6 +60,7 @@ public final class GnssSingleSatCorrection implements Parcelable {













    private int mSingleSatCorrectionFlags;































    /** Defines the constellation of the given satellite as defined in {@link GnssStatus}. */













    @GnssStatus.ConstellationType















    private int mConstellationType;































    /**










@@ -115,7 +116,7 @@ public final class GnssSingleSatCorrection implements Parcelable {













    }































    /** Gets a bitmask of fields present in this object */













    public int getSingleSatCorrectionFlags() {













    public int getSingleSatelliteCorrectionFlags() {















        return mSingleSatCorrectionFlags;















    }

























@@ -136,7 +137,7 @@ public final class GnssSingleSatCorrection implements Parcelable {













     * <p>Interpretation depends on {@link #getConstellationType()}. See {@link















     * GnssStatus#getSvid(int)}.















     */













    public int getSatId() {













    public int getSatelliteId() {















        return mSatId;















    }

























@@ -162,7 +163,7 @@ public final class GnssSingleSatCorrection implements Parcelable {













     * location.















     */















    @FloatRange(from = 0f, to = 1f)













    public float getProbSatIsLos() {













    public float getProbabilityLineOfSight() {















        return mProbSatIsLos;















    }

























@@ -189,8 +190,8 @@ public final class GnssSingleSatCorrection implements Parcelable {













        return mReflectingPlane;















    }





























    /** Returns {@code true} if {@link #getProbSatIsLos()} is valid. */













    public boolean hasSatelliteLineOfSight() {













    /** Returns {@code true} if {@link #getProbabilityLineOfSight()} is valid. */













    public boolean hasValidSatelliteLineOfSight() {















        return (mSingleSatCorrectionFlags & HAS_PROB_SAT_IS_LOS_MASK) != 0;















    }


























@@ -220,11 +221,11 @@ public final class GnssSingleSatCorrection implements Parcelable {













                public GnssSingleSatCorrection createFromParcel(Parcel parcel) {















                    GnssSingleSatCorrection singleSatCorrection =















                            new Builder()













                                    .setSingleSatCorrectionFlags(parcel.readInt())













                                    .setSingleSatelliteCorrectionFlags(parcel.readInt())















                                    .setConstellationType(parcel.readInt())













                                    .setSatId(parcel.readInt())













                                    .setSatelliteId(parcel.readInt())















                                    .setCarrierFrequencyHz(parcel.readFloat())













                                    .setProbSatIsLos(parcel.readFloat())













                                    .setProbabilityLineOfSight(parcel.readFloat())















                                    .setExcessPathLengthMeters(parcel.readFloat())















                                    .setExcessPathLengthUncertaintyMeters(parcel.readFloat())















                                    .setReflectingPlane(










@@ -272,7 +273,7 @@ public final class GnssSingleSatCorrection implements Parcelable {













    }































    /** Builder for {@link GnssSingleSatCorrection} */













    public static class Builder {













    public static final class Builder {































        /**















         * For documentation of below fields, see corresponding fields in {@link









@@ -289,19 +290,19 @@ public final class GnssSingleSatCorrection implements Parcelable {













        private GnssReflectingPlane mReflectingPlane;































        /** Sets a bitmask of fields present in this object */













        public Builder setSingleSatCorrectionFlags(int singleSatCorrectionFlags) {













        public Builder setSingleSatelliteCorrectionFlags(int singleSatCorrectionFlags) {















            mSingleSatCorrectionFlags = singleSatCorrectionFlags;















            return this;















        }































        /** Sets the constellation type. */













        public Builder setConstellationType(int constellationType) {













        public Builder setConstellationType(@GnssStatus.ConstellationType int constellationType) {















            mConstellationType = constellationType;















            return this;















        }





























        /** Sets the Satellite ID. */













        public Builder setSatId(int satId) {













        /** Sets the Satellite ID defined in the ICD of the given constellation. */













        public Builder setSatelliteId(int satId) {















            mSatId = satId;















            return this;















        }









@@ -316,7 +317,8 @@ public final class GnssSingleSatCorrection implements Parcelable {













         * Sets the line-of-sight probability of the satellite at the given location in the range















         * between 0 and 1.















         */













        public Builder setProbSatIsLos(@FloatRange(from = 0f, to = 1f) float probSatIsLos) {













        public Builder setProbabilityLineOfSight(













                @FloatRange(from = 0f, to = 1f) float probSatIsLos) {















            Preconditions.checkArgumentInRange(















                    probSatIsLos, 0, 1, "probSatIsLos should be between 0 and 1.");















            mProbSatIsLos = probSatIsLos;

































location/tests/locationtests/src/android/location/GnssMeasurementCorrectionsTest.java



+9
−9




























Original line number
Diff line number
Diff line








@@ -53,15 +53,15 @@ public class GnssMeasurementCorrectionsTest extends TestCase {













        assertEquals(604000000000000L, measurementCorrections.getToaGpsNanosecondsOfWeek());































        GnssSingleSatCorrection singleSatCorrection =













                measurementCorrections.getSingleSatCorrectionList().get(0);













                measurementCorrections.getSingleSatelliteCorrectionList().get(0);















        GnssSingleSatCorrectionsTest.verifyTestValues(singleSatCorrection);





























        singleSatCorrection = measurementCorrections.getSingleSatCorrectionList().get(1);













        assertEquals(15, singleSatCorrection.getSingleSatCorrectionFlags());













        singleSatCorrection = measurementCorrections.getSingleSatelliteCorrectionList().get(1);













        assertEquals(15, singleSatCorrection.getSingleSatelliteCorrectionFlags());















        assertEquals(GnssStatus.CONSTELLATION_GPS, singleSatCorrection.getConstellationType());













        assertEquals(11, singleSatCorrection.getSatId());













        assertEquals(11, singleSatCorrection.getSatelliteId());















        assertEquals(1575430000f, singleSatCorrection.getCarrierFrequencyHz());













        assertEquals(0.9f, singleSatCorrection.getProbSatIsLos());













        assertEquals(0.9f, singleSatCorrection.getProbabilityLineOfSight());















        assertEquals(50.0f, singleSatCorrection.getExcessPathLengthMeters());















        assertEquals(55.0f, singleSatCorrection.getExcessPathLengthUncertaintyMeters());















        GnssReflectingPlane reflectingPlane = singleSatCorrection.getReflectingPlane();









@@ -82,17 +82,17 @@ public class GnssMeasurementCorrectionsTest extends TestCase {













        List<GnssSingleSatCorrection> singleSatCorrectionList = new ArrayList<>();















        singleSatCorrectionList.add(GnssSingleSatCorrectionsTest.generateTestSingleSatCorrection());















        singleSatCorrectionList.add(generateTestSingleSatCorrection());













        measurementCorrections.setSingleSatCorrectionList(singleSatCorrectionList);













        measurementCorrections.setSingleSatelliteCorrectionList(singleSatCorrectionList);















    }































    private static GnssSingleSatCorrection generateTestSingleSatCorrection() {















        GnssSingleSatCorrection.Builder singleSatCorrection = new GnssSingleSatCorrection.Builder();















        singleSatCorrection













                .setSingleSatCorrectionFlags(8)













                .setSingleSatelliteCorrectionFlags(8)















                .setConstellationType(GnssStatus.CONSTELLATION_GPS)













                .setSatId(11)













                .setSatelliteId(11)















                .setCarrierFrequencyHz(1575430000f)













                .setProbSatIsLos(0.9f)













                .setProbabilityLineOfSight(0.9f)















                .setExcessPathLengthMeters(50.0f)















                .setExcessPathLengthUncertaintyMeters(55.0f)















                .setReflectingPlane(generateTestReflectingPlane());