java/release_notes.txt

   1 Oct 8, 2013: libphonenumber-5.8.7
   2 * Code changes:
   3   - New method in the PhoneNumberUtil API - isMobileNumberPortableRegion.
   4   - Carrier mapper: Updated API and added a getSafeDisplayName method that only returns the carrier
   5                     if it's safe to display to the user.
   6
   7 Oct 7, 2013:
   8 * Code changes:
   9   - Added PhoneNumberToTimeZonesMapper including unittests to the geocoder maven project.
  10   - Added build rules for generating the binary time zones mapping file from the text file.
  11   - Modified PhoneNumberParserServlet.java (the appengine demo) to incorporate time zone mapping.
  12 * Metadata changes:
  13   - Added the time zone mapping file.
  14
  15 Sep 30, 2013:
  16 * Code changes:
  17   - Added PhoneNumberToCarrierMapper including unittests.
  18   - Added build rules for generating binary carrier mapping files from text files.
  19   - Modified PhoneNumberParserServlet.java (the appengine demo) to incorporate carrier mapping.
  20 * Metadata changes:
  21   - Added carrier mapping files for some NANPA countries, EG, SS, MA, DZ, TN, GM, SN, MR, ML, GN,
  22     CI, BF, NE, TG, BJ, MU, LR, SL, GH, NG, TD, CF, CM, CV, ST, GQ, GA, CG, CD, AO, GW, SC, SD, RW,
  23     ET, SO, DJ, KE, TZ, UG, BI, MZ, ZM, MG, ZW, MW, BW, SZ, ZA, AW, FO, GL, GR, NL, BE, FR, GI, PT,
  24     LU, IE, AL, CY, FI, BG, HU, LT, EE, AM, BY, AD, UA, RS, HR, SI, BA, IT, RO, CH, CZ, SK, AT, DK,
  25     NO, PL, DE, BZ, CR, PE, CU, AR, BR, CL, CO, VE, BO, PY, SR, UY, MY, AU, ID, PH, NZ, SG, TH, TL,
  26     BN, PG, TO, VU, FJ, WS, KI, RU, VN, HK, KH, LA, CN, BD, TR, IN, PK, AF, LK, MV, JO, IQ, KW, SA,
  27     YE, OM, PS, AE, IL, BH, QA, BT, NP, IR, TJ, TM, AZ, GE, KG and UZ in English.
  28
  29 Sep 23, 2013: libphonenumber-5.8.6
  30 * Code changes:
  31   - Restructured the geocoder binary generation code, moving the classes under tools/ from
  32     geocoding/ to buildtools/ and renaming AreaCode to PhonePrefix.
  33
  34 Sep 23, 2013: libphonenumber-5.8.5
  35 * Code changes:
  36   - Restructured the geocoder, moving the utility classes to a new module internal/prefixmapper.
  37
  38 Sep 20, 2013: libphonenumber-5.8.4
  39 * Metadata changes:
  40  - Adding a token to indicate which countries have mobile portability.
  41
  42 Sep 20, 2013: libphonenumber-5.8.3
  43 * Code changes:
  44   - PhoneNumberOfflineGeocoder: Moved utility functionality to PrefixFileReader.
  45   - Bug fix: Argentinian (and other countries with mobile tokens) mobile numbers now geocode
  46              correctly.
  47
  48 Sep 19, 2013: libphonenumber-5.8.2
  49 * Code changes:
  50   - New method in the PhoneNumberUtil API - getCountryMobileToken.
  51
  52 Sep 19, 2013: libphonenumber-5.8.1
  53 * Metadata changes:
  54  - New alternate formatting data for country calling code(s): 675
  55  - Updated phone metadata for region code(s):
  56    AO, AU, BF, BW, CA, CH, CI, CN, DE, FR, MA, MR, MU, NI, PG, SA, SE, US, VI
  57  - New short number metadata for region code(s): IQ
  58  - Updated short number metadata for region code(s):
  59    AU, BR, DO, EG, FR, GH, ID, IL, JM, KE, KZ, LR, MW, NG, NI, SA, SE, SL, TZ, US, UZ
  60  - New geocoding data for country calling code(s):
  61    966 (ar, en), 1 (en)
  62
  63 Sep 2, 2013: libphonenumber-5.8
  64 * Code changes:
  65  - Renamed ShortNumberUtil to ShortNumberInfo -> the former class is now deprecated and will be
  66    deleted in a later release. At the moment it just delegates to ShortNumberInfo.
  67  - New methods in the ShortNumberInfo API - isCarrierSpecific, singleton interface,
  68    isPossibleShortNumber, isValidShortNumber, getShortNumberCost. Note this is an experimental API
  69    at the moment and subject to change.
  70  - Bug fixes:
  71     -- AsYouTypeFormatting: 3-digit numbers can be formatted as a group where appropriate
  72     -- AsYouTypeFormatting: Countries with an optional national prefix were considered before to
  73        have always entered it, resulting in bugs where numbers without the national prefix were
  74        not properly formatted.
  75     -- Numbers in Chile that overlap with emergency numbers are no longer marked as connecting to
  76        them
  77     -- Not requiring the NDC to be alone for countries where there is no national prefix in strict
  78        grouping when extracting phone numbers
  79 * Metadata changes:
  80  - New alternate formatting data for country calling code(s):
  81    30, 31, 385, 58, 62, 63, 971, 972
  82  - Updated alternate formatting data for country calling code(s): 43, 44, 49
  83  - Moved emergency phone number data to the ShortNumberMetadata.xml file
  84  - Updated phone metadata for region code(s):
  85    AT, EG, ML, NC, NL, SA
  86  - New short number metadata for region code(s):
  87    AR, CL, CO, ES, MX, NC
  88  - Emergency metadata fixes for region code(s):
  89    GA, JM, MH, VE
  90
  91 Aug 09, 2013: libphonenumber-5.7.2
  92 * Metadata changes:
  93  - New alternate formatting data for country calling code(s):
  94    352, 359, 372, 373, 375, 595, 7, 855
  95  - Updated phone metadata for region code(s):
  96    AR, BF, BH, BR, BY, CH, CM, CN, GE, GW, HN, JM, KH, LT, LU, MU, NP, RO, SO
  97  - New short number metadata for region code(s): BR
  98  - Updated short number metadata for region code(s):
  99    CH, FJ, GB, GG, IM, IT, JE, SH
 100
 101 Aug 8, 2013: libphonenumber-5.7.1
 102 * Metadata/code changes:
 103  - Change to the way the metadata is built; now only parts of the proto that are relevant will be
 104    generated. This means short-code data won't be generated for the normal protos, and fixed-line
 105    data won't be generated for short-number protos. This cuts the metadata binary size approximately
 106    in half.
 107
 108 Jul 17, 2013: libphonenumber-5.7
 109 * Code changes:
 110  - Improve phone number extraction recall.
 111  - Add support for loading short number metadata.
 112
 113 Jul 16, 2013: libphonenumber-5.6.2
 114 * Metadata changes:
 115  - Updated alternate formatting data for country calling code(s): 49, 61
 116  - New metadata for region code(s): TA
 117  - Updated metadata for region code(s):
 118    BF, BH, BI, BJ, BR, CR, EH, GA, GE, GN, GU, IL, IN, IR, KH, KW, KZ, MA, MT,
 119    NA, NE, NL, PH, RO, SH, SO, TK
 120  - New geocoding data for country calling code(s): 47 (en), 82 (ar)
 121  - Updated geocoding data for country calling code(s):
 122    49 (en), 98 (en, fa), 241 (en)
 123
 124 Jul 12, 2013: libphonenumber-5.6.1
 125 * Code changes:
 126  - Rename all instances of PhoneNumberMetadata to PhoneNumberMetadata for consistency.
 127
 128 Jun 05, 2013: libphonenumber-5.6
 129 * Code changes:
 130  - Fix for as-you-type-formatting bug affecting countries with no national prefix
 131    formatting rule, such as China.
 132 * Metadata changes:
 133  - New alternate formatting data for country calling code(s): 351
 134  - Updated alternate formatting data for country calling code(s): 49
 135  - Updated metadata for region code(s):
 136    AS, BG, BH, BJ, BL, CD, CI, DE, DZ, EH, FJ, GF, GP, IN, KH, KZ, MA, MD, MF,
 137    ML, MY, NG, PT, PY, TC, TJ, TT
 138
 139 May 08, 2013: libphonenumber-5.5
 140 * Code changes:
 141  - Changed internal initialization code and made more fields final.
 142    Note that we now throw an exception if an attempt is made to set the
 143    metadata more than once (which should only happen during testing).
 144  - Fix problem with formatNumberForMobileDialing for HU and CL.
 145 * Metadata changes:
 146  - Updated alternate formatting data for country calling code(s): 49
 147  - Updated metadata for region code(s):
 148    AM, BF, BR, CR, DE, MA, MG, MM, SA, TL, UA
 149  - Updated geocoding data for country calling code(s): 374 (am, en, ru)
 150
 151 Apr 19, 2013: libphonenumber-5.4.2
 152 * Metadata changes:
 153  - Updated metadata for region code(s): BF, GA, IN, KR, MV, PH, SO, UA, US
 154
 155 Mar 25, 2013: libphonenumber-5.4.1
 156 * Metadata changes:
 157  - Updated metadata for region code(s): BF, BH, CR, EC, IR, MG, PF, TD, TN
 158  - New geocoding data for country calling code(s): 374 (am, ru)
 159  - Updated geocoding data for country calling code(s):
 160    98 (en, fa), 358 (en, se), 374 (en)
 161
 162 Mar 07, 2013: libphonenumber-5.4
 163 * Code changes:
 164  - Switch formatNumberForMobileDialing to prefer national format to international format when the
 165    number is dialed from the same region the phone number is from.
 166
 167 * Metadata changes:
 168  - Updated metadata for region code(s):
 169    BF, CD, CN, CZ, GN, IR, JP, KR, KW, LR, NZ, TT, UG, ZW
 170  - New geocoding data for country calling code(s): 82 (cs)
 171  - Updated geocoding data for country calling code(s):
 172    82 (en, fr, ko, zh, zh_Hant), 98 (en, fa), 263 (en)
 173
 174 Feb 11, 2013: libphonenumber-5.3.2
 175 * Metadata changes:
 176  - Updated metadata for region code(s):
 177    BD, BE, BY, CA, EH, GR, IE, IN, IS, LI, MA, MU, PT, SE, SG, TL
 178  - New geocoding data for country calling code(s):
 179    375 (be, en, ru), 1 (en)
 180
 181 Jan 25, 2013: libphonenumber-5.3.1
 182 * Metadata changes:
 183  - Updated metadata for region code(s): CN, DK, EH, GN, KH, KW, MA, MY, PA
 184
 185 Jan 08, 2013: libphonenumber-5.3
 186 * Code changes:
 187  - Handling UAN numbers in Argentina better when dialling them locally from a
 188    mobile
 189 * Metadata changes:
 190  - Updated metadata for region code(s):
 191    BE, BW, CL, CN, CO, EH, KW, MA, ML, NG, PL, SY, ZA, ZM
 192  - New geocoding data for country calling code(s): 32 (en, fr, nl)
 193  - Updated geocoding data for country calling code(s): 27 (en), 86 (en, zh)
 194
 195 Dec 06, 2012: libphonenumber-5.2.2
 196 * Metadata changes:
 197  - New metadata for region code(s): EH
 198  - Updated metadata for region code(s): BR, CL, CR, IN, MA, PG, PK, RO
 199  - New geocoding data for country calling code(s): 241 (en)
 200
 201 Nov 26, 2012: libphonenumber-5.2.1
 202 * Metadata changes:
 203  - Updated metadata for region code(s):
 204    AE, AW, BF, CN, DE, JO, KE, KH, LT, MM, MU, NG, RW, SR, TR, VU
 205  - New geocoding data for country calling code(s): 359 (bg, en)
 206
 207 Oct 10, 2012: libphonenumber-5.2
 208 * Code changes:
 209  - Adds isNumberGeographical() method.
 210  - Adds getRegionCodesForCountryCode() method.
 211  - Fixing issue with getSupportedGlobalNetworkCallingCodes()
 212    [http://code.google.com/p/libphonenumber/issues/detail?id=202]
 213  - Ensures that returned collections are unmodifiable where necessary
 214    [there is a very slight risk that this may break existing users who were relying on being able
 215    to modify these collections, but doing so would be breaking lots of other assumptions that this
 216    library makes - if you need to modify any affected collections you must copy them first]
 217 * Metadata changes:
 218  - Updated metadata for region code(s): DE, GR, HR, OM, SB, ZA
 219  - Removed metadata for region code: AN (Netherlands Antilles)
 220  - Updated geocoding data for country calling code(s): 30 (el, en)
 221
 222 Sep 27, 2012: libphonenumber-5.1.4
 223 * Metadata changes:
 224  - Updated metadata for region code(s): AU, EC, KH, LB, TN, US
 225
 226 Sep 17, 2012: libphonenumber-5.1.3
 227 * Metadata changes:
 228  - Updated metadata for region code(s): EG, LA, LB, LI, PY
 229  - Updated metadata for non-geographical calling codes: 800, 808, 888, 979
 230  - Updated geocoding data for country calling code(s): 98 (en), 1 (en)
 231
 232 Sep 11, 2010: libphonenumber-5.1.2
 233 * Bug fix:
 234  - Fixing regression in AsYouTypeFormatter where it no longer worked for numbers entered in national
 235    format for countries with no national prefix, e.g. Spain.
 236
 237 Sep 5, 2010: libphonenumber-5.1.1
 238 * Code changes:
 239   - Added better logging/exception handling for catching cases where metadata is invalid/missing.
 240
 241 Sep 3, 2012: libphonenumber-5.1
 242 * Code changes:
 243  - Inserting a space after the national prefix in the AsYouTypeFormatter when formatting numbers in
 244    national format, if the formatting rules for that country dictate that a space is appropriate.
 245  - Format emergency numbers and short-codes as a block in the AsYouTypeFormatter.
 246 * Metadata changes:
 247  - Updated metadata for region code(s): BF, BG, DZ, GA, IT, JP, KW, PF
 248
 249 Aug 20, 2012: libphonenumber-5.0.3
 250 * Metadata changes:
 251  - New alternate formatting data for country calling code(s): 43
 252  - Updated metadata for region code(s): AT, BF, JO, NG, RU, SL
 253  - New geocoding data for country calling code(s): 62 (en, id), 98 (fa)
 254
 255 Aug 07, 2012: libphonenumber-5.0.2
 256 * Metadata changes:
 257  - Updated metadata for region code(s):
 258    BF, CN, DJ, IL, JO, KH, KZ, MA, MT, MV, MY, NC, NG, SD, SK, SN, TL, UZ
 259  - New geocoding data for country calling code(s): 7 (ru), 98 (en)
 260  - Updated geocoding data for country calling code(s): 7 (en)
 261
 262 July 26th, 2012: libphonenumber-5.0.1
 263 * Metadata changes
 264  - CL, DE ,IN, KR, US
 265  - New geocoding data for country calling codes 40, 57, 66, 82, 91.
 266  - Fixed comments for 353 (IE).
 267
 268 July 12th, 2012: libphonenumber-5.0
 269 * Code changes:
 270  - Support for alternate formats when finding phone numbers.
 271  - Allowing two-digit numbers to be parsed if they are entered in national-format with no
 272    punctuation
 273 * Metadata changes
 274  - IL, GA
 275 * Other
 276  - Reflowed this file to 100 char width to make it unambiguous as to what the standard should be.
 277
 278 July 6th, 2012: libphonenumber-4.9.1
 279 * Metadata changes
 280  - AR, BA, BF, CR, DE, EC, ES, KZ, MK, NC, NG, PF, SB, UZ, non-geo entity 882
 281  - Geocoding data updates for country calling codes 54 (AR) and 81 (JP), new data for 234 (NG)
 282
 283 June 21st, 2012: libphonenumber-4.9
 284 * Bug fix
 285  - formatInOriginalFormat fixed not to add a star sign if it was not present originally.
 286 * Metadata changes
 287  - BF, CZ, ES, KW
 288  - Non-geographical entities with calling code 882 (BebbiCell, Maritime Communications, Oration
 289    Technologies, Telespazio and Thuraya)
 290  - Geocoding data updates for country calling codes 221, 224, 226, 242, 244, 245
 291 * Functionality changes:
 292  - Minimum allowed length for a national significant number (NSN) when parsing changed from 3 to 2.
 293  - Support parsing of RFC3966-formatted strings with an isdn-subaddress or extra parameters
 294    specified.
 295  - Allow soft hyphen to appear in phone numbers (\u00AD)
 296 * Testing changes:
 297  - Add extra unit tests for non-geographical phone number entities
 298  - ExampleNumbersTest testEmergency tests now uses ShortNumberUtil
 299
 300 June 14th, 2012: libphonenumber-4.8.5
 301 * Metadata update only:
 302  - AC, CR, DE, DK, IL, IN, IS, KH, LI, LR, MA, MD, MK, PA, SA, SG, SS
 303
 304 June 6th, 2012: libphonenumber-4.8.4
 305 * Metadata update only:
 306  - AE, RO
 307  - Non-geographical entity with calling code 881 (Iridium)
 308
 309 May 30th, 2012: libphonenumber-4.8.3
 310 * Metadata update only:
 311  - AN, ET, KW, MN, SX, TC, TL
 312
 313 May 16th, 2012: libphonenumber-4.8.2
 314 * Metadata update only:
 315  - BH, CR, EE, JO, KW, LA, QA, SI, TH
 316  - Non-geographical entity with calling code 878 (VISIONng)
 317
 318 May 8th, 2012: libphonenumber-4.8.1
 319 * Metadata update only:
 320  - CA, CI, EG, HK, IN, IR, LB, MA, ME, MM
 321  - Non-geographical entity with calling code 870 (Inmarsat)
 322  - Geocoding updates for country calling codes 1 for new area codes
 323
 324 April 24th, 2012: libphonenumber-4.8
 325 * Functionality changes
 326  - RFC format now outputs a number starting with "tel:"
 327  - Parsing support for numbers in RFC format that contain the country info in the "phone-context"
 328    part
 329  - Support for obtaining area codes for Italy, Vatican City, San Marino
 330 * Metadata changes
 331  - AM, AO, AR, BE, BF, CD, EG, GH, GM, GN, IN, IR, IT, JO, LA, LC, MD, MS, NO, PA, PK, SI, SJ, SO,
 332    SY, TC, TN, UZ, VN, ZW
 333  - Geocoding updates for country calling codes 1, 20, 233, 31, 33, 352, 374, 54, 56, 86
 334 * Refactoring of matching functions, including moving them to PhoneNumberMatcher.
 335
 336 March 16th, 2012: libphonenumber-4.7
 337 * Bug fixes
 338  - Now return "too long" for input that is longer than 250 chars when parsing
 339 * Metadata changes
 340  - AC,AM,AT,AZ,BF,BR,BY,BZ,CR,CU,DE,DJ,EE,EG,ET,GA,GH,HK,HN,ID,IN,JP,KE,KG,KH,KR,KW,KY,LB,LU,MA,MD,
 341    MK,NA,NE,NZ,SA,SB,SC,SE,SL,SN,UZ
 342 * Refactoring of test classes so that tests requiring the test metadata to be loaded have a common
 343   base class which handles this.
 344
 345 February 9th, 2012: libphonenumber-4.6
 346 * Bug fixes
 347  - Fix for formatByPattern to enable RFC formatting to work
 348  - Fix for RFC formatting to work even when the international formatting rule starts with
 349    punctuation
 350  - Logging consistency changes - some warnings are no longer printed, others have become only
 351    WARNINGS
 352  - Fix for isValidNumberForRegion potentially throwing a NPE
 353  - Parsing Israeli * numbers written in international format now works
 354  - PhoneNumberMatcher doesn't match timestamps as phone-numbers
 355 * Metadata changes
 356  - Updates for AN, AX, BF, BJ, BR, BS, DJ, FI, IN, LV, MW, RS, SC, VN
 357  - New countries supported: SS (South Sudan), CW (Curaçao) and BQ (Bonaire, Sint Eustatius and Saba)
 358 * Refactoring of the private formatting functions in PhoneNumberUtil to ensure names are more
 359   descriptive and to reduce code duplication.
 360
 361 January 19th, 2012: libphonenumber-4.5
 362 * Code changes
 363  - Support for non-geographical country calling codes (e.g. +800).
 364  - Modify formatInOriginalFormat to not insert/remove/modify digits in the original number passed
 365    in.
 366  - Fix formatOutOfCountryKeepingAlphaChars to not throw a NPE.
 367
 368 * Metadata changes
 369  - Updates for AR, BH, CI, CN, CR, DE, GA, IL, JO, JP, KE, KZ, LB, LK, LT, MV, MW, MZ, NA, NL, NZ,
 370    PL, RO, SA, SV, TM, UG, US
 371  - New country calling codes: 800, 808, 883, 888, 979
 372  - Geocoding data updates: AR, US
 373
 374 December 9th, 2011: libphonenumber-4.4
 375 * Code changes
 376  - Support for Voicemail numbers
 377  - Support prefixes "xt" and "xtn" to indicate extensions of phone numbers
 378  - Change formatInOriginalFormat to use raw_input for numbers with incorrect leading zeroes, instead
 379    of all invalid numbers.
 380
 381 * Metadata changes
 382  - Updates for AR, BD, CH, CI, IL, IR, IS, IT, JP, KW, LR, MM, NG, SA, SC, UZ
 383
 384 November 24th, 2011: libphonenumber-4.3
 385 * Code changes
 386  - Fix the problems with AYTF crashing for longer numbers entered with +CountryCode, and incorrectly
 387    removing national prefix for some numbers.
 388  - Improve PhoneNumberMatcher to not match numbers ending with '%'.
 389  - Fix formatNumberForMobileDialing to handle Israeli star numbers, Peruvian and Colombian numbers.
 390  - Modify formatInOriginalFormat to use the raw input if we don't have a formatting pattern for a
 391    number.
 392  - Simple offline geocoding function which takes into account the user's region.
 393
 394 * Metadata changes
 395  - Updates for CR, GN, JP, KE, PL, SG, SR, SX, TH, TK
 396
 397 November 10th, 2011: libphonenumber-4.2
 398 * Code changes
 399  - Providing an "exact match" isEmergencyNumber method
 400  - Improvement to PhoneNumberMatcher: requires national prefix to be present when matching
 401    national-format numbers, unless matching for a region where it is explicitly marked in the
 402    metadata that they may be omitted. Applies to leniency level VALID and higher.
 403  - Change formatNumberForMobileDialing not to modify the phoneNumber passed in.
 404
 405 * Metadata changes
 406  - Emergency numbers added for all remaining countries
 407  - Collected data on which numbers we format with a national prefix are commonly written without one
 408    and added this
 409  - Updates for AR, AT, BH, CZ, GR, IR, KM, LT, MX, PT, SE, SO, UG
 410  - Addition of SX (Sint Maarten)
 411
 412 October 19th, 2011: libphonenumber-4.1
 413 * Code changes
 414  - Update code and metadata for countries with IDD "8~10" to accept phone numbers where the "~" is
 415    omitted.
 416  - Modify formatInOriginalFormat to use raw_input (when present) when the number is considered as
 417    invalid by the library.
 418  - Add ShortNumberUtil to deal with international short phone numbers, such as short codes and
 419    emergency numbers.
 420  - Increase the maximum phone-number length accepted when parsing (now set to
 421    16).
 422
 423 * Metadata changes
 424  - Updates: BF, BN, CN, DE, DK, DO, FR, IN, KI, KW, MC, MD, ML, PA, QA, SB, UK, WS
 425  - Emergency number information also added to: AE, AF, AL, AM, AR, AT, AU, BA,
 426    BB, BD, BE, BG, BH, BO, BR, BY, CA, CH, CL, CN, CO, CR, CY, CZ, DE, DJ, DK,
 427    DO, DZ, EC, EE, EG, ES, FI, FJ, FO, FR, GB, GE, GF, GH, GI, GL, GR, GT, GY,
 428    HK, HN, HR, HU, ID, IE, IL, IN, IR, IS, IT, JM, JO, JP, KR, KW, KY, KZ, LB,
 429    LK, LT, LU, LV, MA, MC, MD, ME, MK, ML, MM, MN, MO, MT, MU, MV, MX, MY, NG,
 430    NI, NL, NO, NP, OM, PA, PE, PH, PK, PL, PM, PT, PY, QA, RO, RS, RU, RW, SA,
 431    SB, SD, SE, SG, SI, SK, SL, SM, SR, SV, SY, TD, TH, TJ, TM, TN, TR, TT, TW,
 432    UA, UG, US, UY, UZ, VA, VE, VN, VU, ZA, ZM, ZW
 433
 434 October 6th, 2011: libphonenumber-4.0
 435 * Code changes
 436  - New function formatNumberForMobileDialing, which attempts to format a number in such a way that
 437    the call can be connected from a mobile phone. If this is impossible, for example for numbers
 438    that cannot be internationally dialled, then an empty string is returned.
 439  - Fallback functionality to English for non-CJK languages for geocoding
 440
 441 * Metadata changes
 442  - Collecting data for emergency numbers
 443  - Updates: AR, AU, BR, CN, CZ, EG, GD, IE, IL, JM, KW, KH, SD, SO, TR, UG, UZ
 444  - Geocoding data changes: AO, AR, AT, BJ, BR, CD, CG, CI, CL, CN, CV, DE, ES,
 445    FR, GR, GW, HU, KM, MR, MZ, NL, PL, PT, SE, ST, SZ
 446
 447 September 13th, 2011: libphonenumber-3.9
 448 * Code changes
 449  - Enable AsYouTypeFormatter to handle long IDD and NDD.
 450  - Allow the presence of an IDD following a +.
 451  - Fix formatting of phone numbers which contain only 0s in the national number.
 452  - Refactored some code in geocoding including AreaCodeMap and the storage strategies.
 453
 454 * Metadata changes
 455  - Updates: AM, BE, BH, BJ, BR, BT, BZ, CI, CL, CN, DE, DK, DM, DZ, EC, EG, FJ,
 456    GR, HR, HT, IN, IQ, IS, JM, KE, KG, KH, KR, LA, LB, LR, MA, MD, ML, MO, MX,
 457    MY, NE, NG, PG, PH, PK, PY, QA, SA, SD, SG, SN, TD, TG, TH, TN, TT, UG, YE,
 458    ZA, ZM
 459  - New geocoding data for: AC, CG, CU, CV, EG, ET, FI, FI, FI, GL, JP, KM, MA,
 460    MA, MU, MU, MU, MZ, RS, SH, SH, SL, SO, ST, TG, TG, TG, UG, ZM
 461  - Updated geocoding data for: AR, DE
 462
 463 August 11th, 2011: libphonenumber-3.8
 464 * Code changes
 465  - Fix to demo to not throw null-ptr exceptions for invalid NANPA numbers
 466  - Fixed AYTF to not accept plus signs in the middle of input
 467  - PhoneNumberMatcher improvements - added STRICT_GROUPING and EXACT_GROUPING levels, numbers
 468    followed/preceded by a currency symbol will not match, multiple numbers separated by phone-number
 469    punctuation will now match. ", " is no longer accepted as an extension symbol when matching, only
 470    when parsing. "x" is only accepted as a carrier code or extension marker, not otherwise.
 471  - Changes to handling of leading zeroes - these will not be silently ignored anymore, but will be
 472    stored as part of the number.
 473  - PhoneNumberOfflineGeocoder - new method to get the description of a number that assumes the
 474    validity of the number has already been checked and will not re-verify it.
 475  - Split geocoding US binary data into multiple files.
 476
 477 * Metadata changes
 478  - Updates: AR, AT, AU, AZ, BE, BF, BH, BY, CA, CN, CO, CR, HT, HU, IT, KG, KH,
 479    LB, LI, ME, NC, RS, SE, TT, US, VG, ZA
 480  - New geocoding data for: AL, AM, AO, BF, BJ, BW, CD, CI, CZ, DZ, EE, GH, GM,
 481    GN, GR, GW, HU, IS, KE, LK, LS, LT, LU, LV, MD, MG, MR, NA, PE, QN, SD, SK,
 482    SN, SZ, TN, VE, VN, ZA, ZW
 483  - Updated geocoding data for: GB, PT, US
 484  - Revised sorting of geocoding data
 485
 486 July 5th, 2011
 487 * Code changes
 488  - Refactored AreaCodeMap to minimize binary and memory footprint by using 2 different strategies.
 489  - Refactored BuildMetadataFromXml.java and added unittests.
 490
 491 * Metadata changes
 492  - Regenerate binaries for all existing area code mapping data with smaller sizes.
 493  - Added city-level area code data mapping for US and Canada.
 494
 495 June 29th, 2011
 496 * Code changes
 497  - Fixed issue 38, issue 39, issue 41 and issue 43
 498
 499 * Metadata changes
 500  - Added phone number area mapping files for
 501    - JP in Japanese
 502    - FR in French
 503    - TW in English, Simplified and Traditional Chinese
 504    - RU in English
 505    - IT in English and Italian
 506    - PT in Portuguese
 507    - TR in English and Turkish
 508    - CH in English, German, French and Italian
 509  - Updates: CR, GE, IT, JP, KW, MH, MP, MU, PE, PM, RW, TG, TJ, TK
 510
 511 June 14th, 2011
 512 * Code changes
 513  - Added PhoneNumberOfflineGeocoder, supporting classes and their unittests.
 514  - Added GenerateAreaCodeData to transform phone number area mapping files from text files to binary
 515    files.
 516  - Modified PhoneNumberParserServlet.java and phonenumberparser.jsp to incorporate
 517    PhoneNumberOfflineGeocoding in the appengine demo.
 518
 519 * Metadata changes
 520  - Added phone number area mapping files for NANPA countries and GB in English, NL in Dutch, AR, CL
 521    and ES in Spanish, AT and DE in German, SE in Swedish, BR in Portuguese, KR in English, Korean,
 522    Simplified and Traditional Chinese, and CN in Simplified Chinese.
 523
 524 June 10th, 2011
 525 * Code changes:
 526  - Fixes for PhoneNumberMatcher to be more restrictive in valid mode and not match numbers
 527    surrounded by Latin characters. This ensures, for example, the string abc123456789acg will not be
 528    marked as a phone numbers.
 529  - Enable PhoneNumberUtil to handle all digits, rather than a subset
 530  - Fix for AYTF issue36 and improvement for US AYTF behaviour.
 531 * Metadata changes:
 532  - Updates: BG, EG, ES, GH, PF, SC, SY, VA
 533
 534 May 24th, 2011
 535 * Code changes:
 536  - Phonenumber now implements Serializable.
 537  - findNumbers doesn't accept numbers with mis-matched brackets as phone-numbers
 538  - An offline phone number geocoder has been added. The current implementation just returns the
 539    region name for the phone number; more detailed geocoding will be added later.
 540 * Metadata changes:
 541  - New countries: GF, KP, NC, PA, PF, PW, PY, SB, SR, TO, UY, VU
 542  - Updates: CY, CZ, ES, GB, GQ, JM, MQ, TN, VI
 543
 544 May 9th, 2011
 545 * Code changes:
 546  - Fixed potential for a null-ptr exception in getExampleNumber
 547  - Potential speed improvement with replacement of StringBuffer with StringBuilder
 548 * Metadata changes
 549  - Changed way that international formats are specified to make it easier to do so
 550  - New countries: AX, CC, CX, WF
 551  - Updates: AM, AR, AU, AW, CN, CO, CR, DM, EC, ET, FI, FJ, GH, IN, JP, KE, KM,
 552    KN, LR, MD, MQ, MX, NP, PH, SC, SE, SM, SN, SY, UG, US, VC, VI, ZM
 553
 554 Apr 26th, 2011
 555 * Code changes:
 556  - Improved PhoneNumberMatcher for cases with other numbers before or after the phone number.
 557  - Improved AsYouTypeFormatter not to use formatting rules containing non-formatting characters
 558    (e.g. '*' in Israeli star numbers).
 559 * Metadata changes:
 560  - New countries: FJ, FM, GY, NF, NI, NR, TV.
 561  - Updates: AM, AZ, BF, BW, BZ, CI, CR, GB, GP, HK, JM, KH, LB, LY, MV, PE, PK, SZ, TJ, US.
 562 * Minor documentation updates
 563
 564 Apr 11th, 2011
 565 * Bug fixes:
 566  - Adding date exclusion pattern in PhoneNumberMatcher.
 567  - Fixing bug with selecting a suitable region for numbers with leading zeros where mutiple regions
 568    for that country code are possible.
 569 * Metadata changes:
 570  - Updates: AG, AI, AS, BB, BM, BS, CA, DM, DO, ET, FO, GD, GE, GU, IN, JM, KN, KY, LC, MN, MP, MR,
 571    MS, NO, PR, TC, TR, TT, US, VC, VG, VI
 572  - New countries: CK, FK, GT, IO, KI, SJ, SV
 573 * Documentation updates and some small refactoring to AsYouTypeFormatter
 574
 575 Mar 31st, 2011
 576 * New functionality:
 577  - Can parse and format numbers in RFC-3966 format.
 578  - Added isAlphaNumber to check to see if a number is a "vanity" or "alpha" number
 579  - Can format a number made up of alpha-characters in an "out-of-country" format (e.g. 0011 1
 580    800-SIX-FLAG to dial an American alpha-number from Australia).
 581 * Code changes:
 582  - Renamed private vars, private methods and fixed comments to try and differentiate between country
 583    (calling) codes and region codes.
 584  == Non-backwards-compatible API changes: ==
 585  - Renamed getSupportedCountries to getSupportedRegions, as this more accurately reflects that the
 586    library is based around region codes.
 587  - getNationalSignificantNumber is no longer a static method, but is instead an instance method.
 588 * Metadata changes:
 589  - Bug-fixes and updates for AU, AZ, EE, FI, IN, JO, KW, KZ, MV, RU, RR, VA
 590  - New country: ME
 591
 592 Mar 22nd, 2011
 593 * Metadata changes:
 594  - New mobile-number pattern for AU
 595
 596 Mar 10th, 2011
 597 * New functionality:
 598  - New function to format a number with the preferred domestic carrier code used when parsing,
 599    falling back to a default calling code otherwise (formatNationalNumberWithPreferredCarrierCode).
 600  - We now store the preferred domestic carrier code used when the user calls parseAndKeepRawInput
 601  - New functionality to extract phone-numbers from text (findNumbers). This is just the first
 602    version - it does not extract ALPHA numbers such as 0800 CALL ME, or numbers where alternate
 603    endings are specified (such as 03-331 6005/6006).
 604 * Code changes:
 605  - Tidying up the test file to use several pre-defined phone number constants
 606  - Fixing several lint errors
 607  - Added javadoc to formatNationalNumberWithCarrierCode
 608  - Fixed bug where a null pointer exception was thrown when getAsYouTypeFormatter was called with an
 609    invalid region code
 610  - Improved AsYouTypeFormatter to deal with countries with variable-length patterns such as LU
 611 * Metadata changes:
 612  - Bug-fixes and updates for the following countries: BF, BO, BR, CL, CO, CR, DK, FO, GE, KR, KW,
 613    LA, LU, MU, SC, SH, TR, VE
 614  - New country: SH
 615
 616 Mar 10th, 2011
 617 * Code changes:
 618   - releasing the code to run the demo on localhost or appengine.
 619
 620 Mar 7th, 2011
 621 * Metadata changes:
 622  - Adding support for AC
 623
 624 Feb 11th, 2011
 625 * Metadata changes:
 626  - Update UAN number ranges for IM and JE.
 627
 628 Feb 9th, 2011
 629 * Code changes:
 630   - Better isNumberMatch method. This will now recognise numbers starting with a national prefix as
 631     an NSN_MATCH, instead of SHORT_NSN_MATCH.
 632     == Note Non-backwards-compatible API change here! ==
 633       This will no longer throw a NumberParseException - instead we will return NOT_A_NUMBER if one
 634       or other of the numbers provided do not match.
 635   - New number-type UAN now supported in the code. This represents Company Numbers or Universally
 636     Accessible Numbers.
 637 * Metadata changes:
 638   - Bug-fixes and updates for the following countries: AG, AZ, BA, BE, CA, CU, ES, FI, GB, GD, GG,
 639     IE, IL, IM, IN, IR, IT, JE, JP, KR, KW, NG, NZ, PK, PS, PT, RU, SE, SG, SY, US
 640   - New countries: CO, LU, LY, MC, SM
 641   - Addition of "Personal Number" ranges to all NANPA countries
 642
 643 Jan 31st, 2011
 644 * Code changes:
 645   - Introducing equals() and hashCode() methods for the Phonenumber.PhoneNumber class
 646
 647 Jan 28th, 2011
 648 * Code changes:
 649   - Fixing critical bug with non-Android-compatible code. isEmpty() was being used and CANON_EQ in
 650     reg-ex matches.
 651
 652 Jan 20th, 2011
 653 * Code improvements:
 654   - Handle null phone-numbers when parsing by throwing a NumberParseException.
 655   - Handle extension written with an accented "o", as per Spanish, when parsing.
 656   - Handle U+30FC dashes as phone-number punctuation.
 657   - Allow "ZZ" or null regions to be specified for numbers starting with a full-width "+" symbol, or
 658     with other characters (such as whitespace) before the leading +.
 659   - new getLengthOfNationalDestinationCode function
 660 * Metadata changes:
 661   - New types of numbers introduced: UAN (universal or "company" numbers) and short codes. Note that
 662     "generalDesc" patterns do not encompass short-codes.  No code-support for these has been
 663     introduced as of yet. We are also now enabling the collection of data for information such as
 664     area-code-optional, and no-international-dialling ranges.
 665   - Data updates as per ITU notifications/bug fixes for the following countries: AM, BH, CD, CG, CR,
 666     DE, DJ, EE, GB, GN, HU, IE, JO, JP, LB, LR, MA, MK, MN, MR, NA, PG, SC, SG, SO, SZ, VN, ZA, ZW
 667   - Data added for the following countries: BZ, CU, EC, FO, GI, HN, HT, LK, MT, MV, NU, PS, SD
 668   - Indentation fixes in reg-exes for the following countries: BG, GB
 669   - Allow nationalPrefixForParsing to be specified for countries with no national prefix, to handle
 670     possible carrier prefixes
 671
 672 Jan 3rd, 2011
 673 * Metadata changes:
 674   - Updates to JE
 675   - Updated comments for GB/GG/IM/JE
 676
 677 November 25th, 2010
 678 * Metadata changes:
 679   - Updates to existing countries: AD, AG, AI, AN, AS, BB, BG, BM, BS, BW, CA, DM, DO, GD, GH, GM,
 680     GU, IN, JM, KN, KY, KZ, LB, LC, MP, MS, PR, SY, TC, TT, TZ, US, VC, VG, VI.
 681   - Reorganize reg-exes for better readability.
 682   - Updated comments.
 683
 684 October 22nd, 2010
 685 * Metadata changes:
 686   - Updates to existing countries: AE, GB, GG, IM, JE
 687
 688 October 15th, 2010
 689 * Code improvements:
 690   - Allowed parsing of numbers that start with "++" or a full-width "+" symbol
 691   - Allowed reg-exes for national and possible number patterns to have white space in them in the
 692     source XML file
 693   - Added a more useful toString method for the phone number proto class
 694 * Metadata changes:
 695   - Updates to existing countries: AF, BF, BO, ES, GB, GG, IM, IS, JE, JE, JP, KR, PE, PT, RU, SE,
 696     TT, ZW
 697 * Bug fixes:
 698   - Parsing empty strings with invalid region codes no longer throws a null pointer exception
 699
 700 September 4th, 2010
 701 * Code improvement:
 702   - Added new phone number type: pager
 703 * Metadata change:
 704   - update to existing country: GG, IM, JE, RS, RU
 705 * Bug fixes:
 706   - ArrayOutOfBoundException in AsYouTypeFormatter.getRememberedPosition()
 707   - AsYouTypeFormatter for UK childline number
 708
 709 September 1st, 2010
 710 * Bug fix on KZ metadata.
 711
 712 August 17th, 2010
 713 * Code improvement:
 714   - Refactored BuildMetadataProtoFromXml.java into BuildMetadataFromXml.java and
 715     BuildMetadataProtoFromXml.java
 716   - Added BuildMetadataProtoFromXml.java and JSArrayBuilder.java
 717   - Refactored CountryCodeToRegionCodeMap and CountryCodeToRegionCodeMapForTesting into separate
 718     files.
 719
 720 August 16th, 2010
 721 * Bug fixes
 722   - AsYouTypeFormatter for formatting Chinese geographical numbers entered in national format.
 723   - AsYouTypeFormatter for formatting Chinese 400/800 numbers entered in national format.
 724 * Metadata change:
 725   - new countries: AM, AN, BH, GL, IS
 726   - adding national prefix 1 to all NANPA countries.
 727   - update to existing countries: BF, FR, UK, PK, RE
 728
 729 August 4th, 2010
 730 * Further improve startup performance
 731   - Preload no country specific metadata at startup.
 732   - Stop creating the file containing mapping from country calling code to region code and loading
 733     it at startup; instead, do the initialization in PhoneNumberUtil.
 734
 735 July 31th, 2010
 736
 737 * Improve startup performance
 738   - Separate generated metadata binary file to one file per region
 739   - Preload US at start up, and load other region at the time when needed
 740   - Create a file containing mapping from country calling code to region code, and load it at
 741     startup
 742   - Same change also applied to unittests
 743
 744 July 30th, 2010
 745 * Metadata change:
 746   - new country: TL
 747   - update to existing country: AZ, CN, FR, GH, JO, LA, PG, PK, QA, SZ, UA, VN
 748
 749 * Code improvement
 750   - China local number formatting for AsYouTypeFormatter
 751   - improve extension parsing to handle number in the form of +1 (645) 123 1234 ext. 910#