Bluesky API council review
Making method names clearer and adding more annotations.
Bug: 124882841
Test: Current Tests Pass.
Change-Id: Ic36f9ac6e69280f3efa9f812fee1ff6e4e4b1773
diff --git a/api/system-current.txt b/api/system-current.txt
index cf933dc..eee8d81 100644
--- a/api/system-current.txt
+++ b/api/system-current.txt
@@ -3036,21 +3036,21 @@
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 @@
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 @@
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 @@
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 {
diff --git a/location/java/android/location/GnssMeasurementCorrections.java b/location/java/android/location/GnssMeasurementCorrections.java
index 3ce48b4..9d3211d 100644
--- a/location/java/android/location/GnssMeasurementCorrections.java
+++ b/location/java/android/location/GnssMeasurementCorrections.java
@@ -124,7 +124,7 @@
* 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 @@
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 @@
.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 @@
}
/** 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 @@
* 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;
diff --git a/location/java/android/location/GnssReflectingPlane.java b/location/java/android/location/GnssReflectingPlane.java
index 64b3752..9a106a7 100644
--- a/location/java/android/location/GnssReflectingPlane.java
+++ b/location/java/android/location/GnssReflectingPlane.java
@@ -116,7 +116,7 @@
}
/** Builder for {@link GnssReflectingPlane} */
- public static class Builder {
+ public static final class Builder {
/** For documentation, see corresponding fields in {@link GnssReflectingPlane}. */
private double mLatitudeDegrees;
diff --git a/location/java/android/location/GnssSingleSatCorrection.java b/location/java/android/location/GnssSingleSatCorrection.java
index 4d5303f..f719e1a 100644
--- a/location/java/android/location/GnssSingleSatCorrection.java
+++ b/location/java/android/location/GnssSingleSatCorrection.java
@@ -60,6 +60,7 @@
private int mSingleSatCorrectionFlags;
/** Defines the constellation of the given satellite as defined in {@link GnssStatus}. */
+ @GnssStatus.ConstellationType
private int mConstellationType;
/**
@@ -115,7 +116,7 @@
}
/** Gets a bitmask of fields present in this object */
- public int getSingleSatCorrectionFlags() {
+ public int getSingleSatelliteCorrectionFlags() {
return mSingleSatCorrectionFlags;
}
@@ -136,7 +137,7 @@
* <p>Interpretation depends on {@link #getConstellationType()}. See {@link
* GnssStatus#getSvid(int)}.
*/
- public int getSatId() {
+ public int getSatelliteId() {
return mSatId;
}
@@ -162,7 +163,7 @@
* location.
*/
@FloatRange(from = 0f, to = 1f)
- public float getProbSatIsLos() {
+ public float getProbabilityLineOfSight() {
return mProbSatIsLos;
}
@@ -189,8 +190,8 @@
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 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 @@
}
/** 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 @@
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 @@
* 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;
diff --git a/location/tests/locationtests/src/android/location/GnssMeasurementCorrectionsTest.java b/location/tests/locationtests/src/android/location/GnssMeasurementCorrectionsTest.java
index 8f46e84..ae5ca40 100644
--- a/location/tests/locationtests/src/android/location/GnssMeasurementCorrectionsTest.java
+++ b/location/tests/locationtests/src/android/location/GnssMeasurementCorrectionsTest.java
@@ -53,15 +53,15 @@
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 @@
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());
diff --git a/location/tests/locationtests/src/android/location/GnssSingleSatCorrectionsTest.java b/location/tests/locationtests/src/android/location/GnssSingleSatCorrectionsTest.java
index f358806..60f33f0 100644
--- a/location/tests/locationtests/src/android/location/GnssSingleSatCorrectionsTest.java
+++ b/location/tests/locationtests/src/android/location/GnssSingleSatCorrectionsTest.java
@@ -40,11 +40,11 @@
}
public static void verifyTestValues(GnssSingleSatCorrection singleSatCorrection) {
- assertEquals(15, singleSatCorrection.getSingleSatCorrectionFlags());
+ assertEquals(15, singleSatCorrection.getSingleSatelliteCorrectionFlags());
assertEquals(GnssStatus.CONSTELLATION_GALILEO, singleSatCorrection.getConstellationType());
- assertEquals(12, singleSatCorrection.getSatId());
+ assertEquals(12, singleSatCorrection.getSatelliteId());
assertEquals(1575420000f, singleSatCorrection.getCarrierFrequencyHz());
- assertEquals(0.1f, singleSatCorrection.getProbSatIsLos());
+ assertEquals(0.1f, singleSatCorrection.getProbabilityLineOfSight());
assertEquals(10.0f, singleSatCorrection.getExcessPathLengthMeters());
assertEquals(5.0f, singleSatCorrection.getExcessPathLengthUncertaintyMeters());
GnssReflectingPlane reflectingPlane = singleSatCorrection.getReflectingPlane();
@@ -52,27 +52,27 @@
}
private static void setTestValues(GnssSingleSatCorrection.Builder singleSatCorrection) {
- GnssSingleSatCorrection singleSatCorr = generateTestSingleSatCorrection();
+ GnssSingleSatCorrection singleSatCor = generateTestSingleSatCorrection();
singleSatCorrection
- .setSingleSatCorrectionFlags(singleSatCorr.getSingleSatCorrectionFlags())
- .setConstellationType(singleSatCorr.getConstellationType())
- .setSatId(singleSatCorr.getSatId())
- .setCarrierFrequencyHz(singleSatCorr.getCarrierFrequencyHz())
- .setProbSatIsLos(singleSatCorr.getProbSatIsLos())
- .setExcessPathLengthMeters(singleSatCorr.getExcessPathLengthMeters())
+ .setSingleSatelliteCorrectionFlags(singleSatCor.getSingleSatelliteCorrectionFlags())
+ .setConstellationType(singleSatCor.getConstellationType())
+ .setSatelliteId(singleSatCor.getSatelliteId())
+ .setCarrierFrequencyHz(singleSatCor.getCarrierFrequencyHz())
+ .setProbabilityLineOfSight(singleSatCor.getProbabilityLineOfSight())
+ .setExcessPathLengthMeters(singleSatCor.getExcessPathLengthMeters())
.setExcessPathLengthUncertaintyMeters(
- singleSatCorr.getExcessPathLengthUncertaintyMeters())
- .setReflectingPlane(singleSatCorr.getReflectingPlane());
+ singleSatCor.getExcessPathLengthUncertaintyMeters())
+ .setReflectingPlane(singleSatCor.getReflectingPlane());
}
public static GnssSingleSatCorrection generateTestSingleSatCorrection() {
GnssSingleSatCorrection.Builder singleSatCorrection =
new GnssSingleSatCorrection.Builder()
- .setSingleSatCorrectionFlags(15)
+ .setSingleSatelliteCorrectionFlags(15)
.setConstellationType(GnssStatus.CONSTELLATION_GALILEO)
- .setSatId(12)
+ .setSatelliteId(12)
.setCarrierFrequencyHz(1575420000f)
- .setProbSatIsLos(0.1f)
+ .setProbabilityLineOfSight(0.1f)
.setExcessPathLengthMeters(10.0f)
.setExcessPathLengthUncertaintyMeters(5.0f)
.setReflectingPlane(GnssReflectingPlaneTest.generateTestReflectingPlane());
diff --git a/services/core/jni/com_android_server_location_GnssLocationProvider.cpp b/services/core/jni/com_android_server_location_GnssLocationProvider.cpp
index d178c3a..fe94168 100644
--- a/services/core/jni/com_android_server_location_GnssLocationProvider.cpp
+++ b/services/core/jni/com_android_server_location_GnssLocationProvider.cpp
@@ -2248,7 +2248,7 @@
measCorrClass, "getToaGpsNanosecondsOfWeek", "()J");
method_correctionsGetSingleSatCorrectionList = env->GetMethodID(
- measCorrClass, "getSingleSatCorrectionList", "()Ljava.util.List;");
+ measCorrClass, "getSingleSatelliteCorrectionList", "()Ljava.util.List;");
}
jdouble latitudeDegreesCorr = env->CallDoubleMethod(
@@ -2285,15 +2285,15 @@
if (firstGnssMeasurementCorrectionInjected == false) {
jclass singleSatCorrClass = env->GetObjectClass(singleSatCorrectionObj);
method_correctionSatFlags = env->GetMethodID(
- singleSatCorrClass, "getSingleSatCorrectionFlags", "()I");
+ singleSatCorrClass, "getSingleSatelliteCorrectionFlags", "()I");
method_correctionSatConstType = env->GetMethodID(
singleSatCorrClass, "getConstellationType", "()I");
method_correctionSatId= env->GetMethodID(
- singleSatCorrClass, "getSatId", "()I");
+ singleSatCorrClass, "getSatelliteId", "()I");
method_correctionSatCarrierFreq = env->GetMethodID(
singleSatCorrClass, "getCarrierFrequencyHz", "()F");
method_correctionSatIsLosProb = env->GetMethodID(
- singleSatCorrClass,"getProbSatIsLos", "()F");
+ singleSatCorrClass,"getProbabilityLineOfSight", "()F");
method_correctionSatEpl = env->GetMethodID(
singleSatCorrClass, "getExcessPathLengthMeters", "()F");
method_correctionSatEplUnc = env->GetMethodID(