Add doc for NetworkScore#getLegacyInt am: 0422927cd8

Original change: https://android-review.googlesource.com/c/platform/packages/modules/Connectivity/+/1727811

Change-Id: Iefcf115b045de94d28fb9d0fe047b27445701851
This commit is contained in:
Chalard Jean
2021-06-08 23:09:43 +00:00
committed by Automerger Merge Worker

View File

@@ -93,6 +93,10 @@ public final class NetworkScore implements Parcelable {
mKeepConnectedReason = in.readInt();
}
/**
* Get the legacy int score embedded in this NetworkScore.
* @see Builder#setLegacyInt(int)
*/
public int getLegacyInt() {
return mLegacyInt;
}
@@ -212,7 +216,9 @@ public final class NetworkScore implements Parcelable {
/**
* Sets the legacy int for this score.
*
* Do not rely on this. It will be gone by the time S is released.
* This will be used for measurements and logs, but will no longer be used for ranking
* networks against each other. Callers that existed before Android S should send what
* they used to send as the int score.
*
* @param score the legacy int
* @return this