summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Sarah Chin <sarahchin@google.com> 2020-01-10 23:53:25 +0000
committer Gerrit Code Review <noreply-gerritcodereview@google.com> 2020-01-10 23:53:25 +0000
commitbbf2a838261ea1bece8d86e2224eabaf63f365ea (patch)
treeb189d6b10f1eeceac981ddb873ccf4a1c1f2a0a5
parent8f5a92df2028b4138b59a1b576a1ce815775f61b (diff)
parentc9e48d9403e6f58ca0c7da574bec3eaef0e8f85c (diff)
Merge "Update javadocs for API review"
-rw-r--r--core/java/android/telephony/SubscriptionPlan.java23
-rw-r--r--telephony/java/android/telephony/SubscriptionManager.java4
2 files changed, 13 insertions, 14 deletions
diff --git a/core/java/android/telephony/SubscriptionPlan.java b/core/java/android/telephony/SubscriptionPlan.java
index e24eb2696c6c..28a5c2086ede 100644
--- a/core/java/android/telephony/SubscriptionPlan.java
+++ b/core/java/android/telephony/SubscriptionPlan.java
@@ -44,6 +44,14 @@ import java.util.Objects;
* as explaining how much mobile data they have remaining, and what will happen
* when they run out.
*
+ * If specifying network types, the developer must supply at least one plan
+ * that applies to all network types (default), and all additional plans
+ * may not include a particular network type more than once.
+ * This is enforced by {@link SubscriptionManager} when setting the plans.
+ *
+ * Plan selection will prefer plans that have specific network types defined
+ * over plans that apply to all network types.
+ *
* @see SubscriptionManager#setSubscriptionPlans(int, java.util.List)
* @see SubscriptionManager#getSubscriptionPlans(int)
*/
@@ -213,7 +221,7 @@ public final class SubscriptionPlan implements Parcelable {
/**
* Return an array containing all {@link NetworkType}s this SubscriptionPlan applies to.
- * A null array means this SubscriptionPlan applies to all network types.
+ * A null value means this SubscriptionPlan applies to all network types.
*/
public @Nullable @NetworkType int[] getNetworkTypes() {
return networkTypes;
@@ -372,20 +380,13 @@ public final class SubscriptionPlan implements Parcelable {
/**
* Set the network types this SubscriptionPlan applies to.
- * The developer must supply at least one plan that applies to all network types (default),
- * and all additional plans may not include a particular network type more than once.
- * Plan selection will prefer plans that have specific network types defined
- * over plans that apply to all network types.
*
* @param networkTypes a set of all {@link NetworkType}s that apply to this plan.
- * A null value or empty array means the plan applies to all network types.
+ * A null value means the plan applies to all network types,
+ * and an empty array means the plan applies to no network types.
*/
public @NonNull Builder setNetworkTypes(@Nullable @NetworkType int[] networkTypes) {
- if (networkTypes == null || networkTypes.length == 0) {
- plan.networkTypes = null;
- } else {
- plan.networkTypes = networkTypes;
- }
+ plan.networkTypes = networkTypes;
return this;
}
}
diff --git a/telephony/java/android/telephony/SubscriptionManager.java b/telephony/java/android/telephony/SubscriptionManager.java
index 9d744a61db68..4de9e1e4c1c7 100644
--- a/telephony/java/android/telephony/SubscriptionManager.java
+++ b/telephony/java/android/telephony/SubscriptionManager.java
@@ -2500,12 +2500,10 @@ public class SubscriptionManager {
* @param plans the list of plans. The first plan is always the primary and
* most important plan. Any additional plans are secondary and
* may not be displayed or used by decision making logic.
- * The list of all plans must meet the requirements defined in
- * {@link SubscriptionPlan.Builder#setNetworkTypes(int[])}.
* @throws SecurityException if the caller doesn't meet the requirements
* outlined above.
* @throws IllegalArgumentException if plans don't meet the requirements
- * mentioned above.
+ * defined in {@link SubscriptionPlan}.
*/
public void setSubscriptionPlans(int subId, @NonNull List<SubscriptionPlan> plans) {
try {