From 0962fe946eae58174b9168e3bae4c4de441eb71e Mon Sep 17 00:00:00 2001 From: chen xu Date: Sun, 10 Mar 2019 21:05:02 -0700 Subject: improve carrier id documentation Bug: 126440877 Test: Build Change-Id: I1e1efa5c2af280176ffee8567818940a0bcade19 --- .../carrierconfig/DefaultCarrierConfigService.java | 24 ++++++++++++++-------- 1 file changed, 15 insertions(+), 9 deletions(-) (limited to 'src') diff --git a/src/com/android/carrierconfig/DefaultCarrierConfigService.java b/src/com/android/carrierconfig/DefaultCarrierConfigService.java index d69722e..2980332 100644 --- a/src/com/android/carrierconfig/DefaultCarrierConfigService.java +++ b/src/com/android/carrierconfig/DefaultCarrierConfigService.java @@ -48,7 +48,13 @@ public class DefaultCarrierConfigService extends CarrierService { * Returns per-network overrides for carrier configuration. * * This returns a carrier config bundle appropriate for the given carrier by reading data from - * files in our assets folder. First we look for file named after + * files in our assets folder. Config files in assets folder are carrier-id-indexed + * {@link TelephonyManager#getSimCarrierId()}. NOTE: config files named after mccmnc + * are for those without a matching carrier id and should be renamed to carrier id once the + * missing IDs are added to + * carrier id list + * + * First, look for file named after * carrier_config_carrierid__.xml if carrier id is not * {@link TelephonyManager#UNKNOWN_CARRIER_ID}. Note is to improve the * readability which should not be used to search asset files. If there is no configuration, @@ -143,26 +149,26 @@ public class DefaultCarrierConfigService extends CarrierService { * by {@link PersistableBundle#restoreFromXml}. All the matching bundles will be flattened and * returned as a single bundle.

* - *

Here is an example document. The second bundle will be applied to the first only if the - * GID1 is ABCD. + *

Here is an example document in vendor.xml. * 

{@code
      * 
-     *     
+     *     
      *         
      *     
-     *     
+     *     
      *         
      *     
      * 
      * }

* - *

Here is another example document in vendor.xml. + *

Here is an example document. The second bundle will be applied to the first only if the + * GID1 is ABCD. * 

{@code
      * 
-     *     
+     *     
      *         
      *     
-     *     
+     *     
      *         
      *     
      * 
@@ -170,7 +176,7 @@ public class DefaultCarrierConfigService extends CarrierService {
      *
      * @param parser an XmlPullParser pointing at the beginning of the document.
      * @param id the details of the SIM operator used to filter parts of the document. If read from
-     *           file named after carrier id, this will be set to {@null code} as no filter match
+     *           files named after carrier id, this will be set to {@null code} as no filter match
      *           needed.
      * @return a possibly empty PersistableBundle containing the config values.
      */
-- 
cgit v1.2.3