JAVA: Add Maven support for offline phone number geocoder.
[platform/upstream/libphonenumber.git] / java / release_notes.txt
1 November 10th, 2011: libphonenumber-4.2
2 * Code changes
3  - Providing an "exact match" isEmergencyNumber method
4  - Improvement to PhoneNumberMatcher: requires national prefix to be present
5    when matching national-format numbers, unless matching for a region where it
6    is explicitly marked in the metadata that they may be omitted. Applies to
7    leniency level VALID and higher.
8  - Change formatNumberForMobileDialing not to modify the phoneNumber passed in.
9
10 * Metadata changes
11  - Emergency numbers added for all remaining countries
12  - Collected data on which numbers we format with a national prefix are
13    commonly written without one and added this
14  - Updates for AR, AT, BH, CZ, GR, IR, KM, LT, MX, PT, SE, SO, UG
15  - Addition of SX (Sint Maarten)
16
17 October 19th, 2011: libphonenumber-4.1
18 * Code changes
19  - Update code and metadata for countries with IDD "8~10" to accept phone
20    numbers where the "~" is omitted.
21  - Modify formatInOriginalFormat to use raw_input (when present) when the number
22    is considered as invalid by the library.
23  - Add ShortNumberUtil to deal with international short phone numbers, such as
24    short codes and emergency numbers.
25  - Increase the maximum phone-number length accepted when parsing (now set to
26    16).
27
28 * Metadata changes
29  - Updates: BF, BN, CN, DE, DK, DO, FR, IN, KI, KW, MC, MD, ML, PA, QA, SB, UK,
30    WS
31  - Emergency number information also added to: AE, AF, AL, AM, AR, AT, AU, BA,
32    BB, BD, BE, BG, BH, BO, BR, BY, CA, CH, CL, CN, CO, CR, CY, CZ, DE, DJ, DK,
33    DO, DZ, EC, EE, EG, ES, FI, FJ, FO, FR, GB, GE, GF, GH, GI, GL, GR, GT, GY,
34    HK, HN, HR, HU, ID, IE, IL, IN, IR, IS, IT, JM, JO, JP, KR, KW, KY, KZ, LB,
35    LK, LT, LU, LV, MA, MC, MD, ME, MK, ML, MM, MN, MO, MT, MU, MV, MX, MY, NG,
36    NI, NL, NO, NP, OM, PA, PE, PH, PK, PL, PM, PT, PY, QA, RO, RS, RU, RW, SA,
37    SB, SD, SE, SG, SI, SK, SL, SM, SR, SV, SY, TD, TH, TJ, TM, TN, TR, TT, TW,
38    UA, UG, US, UY, UZ, VA, VE, VN, VU, ZA, ZM, ZW
39
40 October 6th, 2011: libphonenumber-4.0
41 * Code changes
42  - New function formatNumberForMobileDialing, which attempts to format a number in
43    such a way that the call can be connected from a mobile phone. If this is
44    impossible, for example for numbers that cannot be internationally dialled,
45    then an empty string is returned.
46  - Fallback functionality to English for non-CJK languages for geocoding
47
48 * Metadata changes
49  - Collecting data for emergency numbers
50  - Updates: AR, AU, BR, CN, CZ, EG, GD, IE, IL, JM, KW, KH, SD, SO, TR, UG, UZ
51  - Geocoding data changes: AO, AR, AT, BJ, BR, CD, CG, CI, CL, CN, CV, DE, ES,
52    FR, GR, GW, HU, KM, MR, MZ, NL, PL, PT, SE, ST, SZ
53
54 September 13th, 2011: libphonenumber-3.9
55 * Code changes
56  - Enable AsYouTypeFormatter to handle long IDD and NDD.
57  - Allow the presence of an IDD following a +.
58  - Fix formatting of phone numbers which contain only 0s in the national number.
59  - Refactored some code in geocoding including AreaCodeMap and the storage
60    strategies.
61
62 * Metadata changes
63  - Updates: AM, BE, BH, BJ, BR, BT, BZ, CI, CL, CN, DE, DK, DM, DZ, EC, EG, FJ,
64    GR, HR, HT, IN, IQ, IS, JM, KE, KG, KH, KR, LA, LB, LR, MA, MD, ML, MO, MX,
65    MY, NE, NG, PG, PH, PK, PY, QA, SA, SD, SG, SN, TD, TG, TH, TN, TT, UG, YE,
66    ZA, ZM
67  - New geocoding data for: AC, CG, CU, CV, EG, ET, FI, FI, FI, GL, JP, KM, MA,
68    MA, MU, MU, MU, MZ, RS, SH, SH, SL, SO, ST, TG, TG, TG, UG, ZM
69  - Updated geocoding data for: AR, DE
70
71 August 11th, 2011: libphonenumber-3.8
72 * Code changes
73  - Fix to demo to not throw null-ptr exceptions for invalid NANPA numbers
74  - Fixed AYTF to not accept plus signs in the middle of input
75  - PhoneNumberMatcher improvements - added STRICT_GROUPING and EXACT_GROUPING
76    levels, numbers followed/preceded by a currency symbol will not match,
77    multiple numbers separated by phone-number punctuation will now match. ", "
78    is no longer accepted as an extension symbol when matching, only when
79    parsing. "x" is only accepted as a carrier code or extension marker, not
80    otherwise.
81  - Changes to handling of leading zeroes - these will not be silently ignored
82    anymore, but will be stored as part of the number.
83  - PhoneNumberOfflineGeocoder - new method to get the description of a number that assumes
84    the validity of the number has already been checked and will not re-verify it.
85  - Split geocoding US binary data into multiple files.
86
87 * Metadata changes
88  - Updates: AR, AT, AU, AZ, BE, BF, BH, BY, CA, CN, CO, CR, HT, HU, IT, KG, KH,
89    LB, LI, ME, NC, RS, SE, TT, US, VG, ZA
90  - New geocoding data for: AL, AM, AO, BF, BJ, BW, CD, CI, CZ, DZ, EE, GH, GM,
91    GN, GR, GW, HU, IS, KE, LK, LS, LT, LU, LV, MD, MG, MR, NA, PE, QN, SD, SK,
92    SN, SZ, TN, VE, VN, ZA, ZW
93  - Updated geocoding data for: GB, PT, US
94  - Revised sorting of geocoding data
95
96 July 5th, 2011
97 * Code changes
98  - Refactored AreaCodeMap to minimize binary and memory footprint by using 2 different strategies.
99  - Refactored BuildMetadataFromXml.java and added unittests.
100
101 * Metadata changes
102  - Regenerate binaries for all existing area code mapping data with smaller sizes.
103  - Added city-level area code data mapping for US and Canada.
104
105 June 29th, 2011
106 * Code changes
107  - Fixed issue 38, issue 39, issue 41 and issue 43
108
109 * Metadata changes
110  - Added phone number area mapping files for
111    - JP in Japanese
112    - FR in French
113    - TW in English, Simplified and Traditional Chinese
114    - RU in English
115    - IT in English and Italian
116    - PT in Portuguese
117    - TR in English and Turkish
118    - CH in English, German, French and Italian
119  - Updates: CR, GE, IT, JP, KW, MH, MP, MU, PE, PM, RW, TG, TJ, TK
120
121 June 14th, 2011
122 * Code changes
123  - Added PhoneNumberOfflineGeocoder, supporting classes and their unittests.
124  - Added GenerateAreaCodeData to transform phone number area mapping files from text files to binary
125    files.
126  - Modified PhoneNumberParserServlet.java and phonenumberparser.jsp to incorporate
127    PhoneNumberOfflineGeocoding in the appengine demo.
128
129 * Metadata changes
130  - Added phone number area mapping files for NANPA countries and GB in English, NL in Dutch, AR, CL
131    and ES in Spanish, AT and DE in German, SE in Swedish, BR in Portuguese, KR in English, Korean,
132    Simplified and Traditional Chinese, and CN in Simplified Chinese.
133
134 June 10th, 2011
135 * Code changes:
136  - Fixes for PhoneNumberMatcher to be more restrictive in valid mode and not match numbers
137    surrounded by Latin characters. This ensures, for example, the string abc123456789acg will not be
138    marked as a phone numbers.
139  - Enable PhoneNumberUtil to handle all digits, rather than a subset
140  - Fix for AYTF issue36 and improvement for US AYTF behaviour.
141 * Metadata changes:
142  - Updates: BG, EG, ES, GH, PF, SC, SY, VA
143
144 May 24th, 2011
145 * Code changes:
146  - Phonenumber now implements Serializable.
147  - findNumbers doesn't accept numbers with mis-matched brackets as phone-numbers
148  - An offline phone number geocoder has been added. The current implementation just returns the
149    region name for the phone number; more detailed geocoding will be added later.
150 * Metadata changes:
151  - New countries: GF, KP, NC, PA, PF, PW, PY, SB, SR, TO, UY, VU
152  - Updates: CY, CZ, ES, GB, GQ, JM, MQ, TN, VI
153
154 May 9th, 2011
155 * Code changes:
156  - Fixed potential for a null-ptr exception in getExampleNumber
157  - Potential speed improvement with replacement of StringBuffer with StringBuilder
158 * Metadata changes
159  - Changed way that international formats are specified to make it easier to do so
160  - New countries: AX, CC, CX, WF
161  - Updates: AM, AR, AU, AW, CN, CO, CR, DM, EC, ET, FI, FJ, GH, IN, JP, KE, KM,
162    KN, LR, MD, MQ, MX, NP, PH, SC, SE, SM, SN, SY, UG, US, VC, VI, ZM
163
164 Apr 26th, 2011
165 * Code changes:
166  - Improved PhoneNumberMatcher for cases with other numbers before or after the phone number.
167  - Improved AsYouTypeFormatter not to use formatting rules containing non-formatting characters
168    (e.g. '*' in Israeli star numbers).
169 * Metadata changes:
170  - New countries: FJ, FM, GY, NF, NI, NR, TV.
171  - Updates: AM, AZ, BF, BW, BZ, CI, CR, GB, GP, HK, JM, KH, LB, LY, MV, PE, PK, SZ, TJ, US.
172 * Minor documentation updates
173
174 Apr 11th, 2011
175 * Bug fixes:
176  - Adding date exclusion pattern in PhoneNumberMatcher.
177  - Fixing bug with selecting a suitable region for numbers with leading zeros where mutiple regions
178    for that country code are possible.
179 * Metadata changes:
180  - Updates: AG, AI, AS, BB, BM, BS, CA, DM, DO, ET, FO, GD, GE, GU, IN, JM, KN, KY, LC, MN, MP, MR,
181    MS, NO, PR, TC, TR, TT, US, VC, VG, VI
182  - New countries: CK, FK, GT, IO, KI, SJ, SV
183 * Documentation updates and some small refactoring to AsYouTypeFormatter
184
185 Mar 31st, 2011
186 * New functionality:
187  - Can parse and format numbers in RFC-3966 format.
188  - Added isAlphaNumber to check to see if a number is a "vanity" or "alpha" number
189  - Can format a number made up of alpha-characters in an "out-of-country" format (e.g. 0011 1
190    800-SIX-FLAG to dial an American alpha-number from Australia).
191 * Code changes:
192  - Renamed private vars, private methods and fixed comments to try and differentiate between country
193    (calling) codes and region codes.
194  == Non-backwards-compatible API changes: ==
195  - Renamed getSupportedCountries to getSupportedRegions, as this more accurately reflects that the
196    library is based around region codes.
197  - getNationalSignificantNumber is no longer a static method, but is instead an instance method.
198 * Metadata changes:
199  - Bug-fixes and updates for AU, AZ, EE, FI, IN, JO, KW, KZ, MV, RU, RR, VA
200  - New country: ME
201
202 Mar 22nd, 2011
203 * Metadata changes:
204  - New mobile-number pattern for AU
205
206 Mar 10th, 2011
207 * New functionality:
208  - New function to format a number with the preferred domestic carrier code used when parsing,
209    falling back to a default calling code otherwise (formatNationalNumberWithPreferredCarrierCode).
210  - We now store the preferred domestic carrier code used when the user calls parseAndKeepRawInput
211  - New functionality to extract phone-numbers from text (findNumbers). This is just the first
212    version - it does not extract ALPHA numbers such as 0800 CALL ME, or numbers where alternate
213    endings are specified (such as 03-331 6005/6006).
214 * Code changes:
215  - Tidying up the test file to use several pre-defined phone number constants
216  - Fixing several lint errors
217  - Added javadoc to formatNationalNumberWithCarrierCode
218  - Fixed bug where a null pointer exception was thrown when getAsYouTypeFormatter was called with an
219    invalid region code
220  - Improved AsYouTypeFormatter to deal with countries with variable-length patterns such as LU
221 * Metadata changes:
222  - Bug-fixes and updates for the following countries: BF, BO, BR, CL, CO, CR, DK, FO, GE, KR, KW,
223    LA, LU, MU, SC, SH, TR, VE
224  - New country: SH
225
226 Mar 10th, 2011
227 * Code changes:
228   - releasing the code to run the demo on localhost or appengine.
229
230 Mar 7th, 2011
231 * Metadata changes:
232  - Adding support for AC
233
234 Feb 11th, 2011
235 * Metadata changes:
236  - Update UAN number ranges for IM and JE.
237
238 Feb 9th, 2011
239 * Code changes:
240   - Better isNumberMatch method. This will now recognise numbers starting with a national prefix as
241     an NSN_MATCH, instead of SHORT_NSN_MATCH.
242     == Note Non-backwards-compatible API change here! ==
243       This will no longer throw a NumberParseException - instead we will return NOT_A_NUMBER if one
244       or other of the numbers provided do not match.
245   - New number-type UAN now supported in the code. This represents Company Numbers or Universally
246     Accessible Numbers.
247 * Metadata changes:
248   - Bug-fixes and updates for the following countries: AG, AZ, BA, BE, CA, CU, ES, FI, GB, GD, GG,
249     IE, IL, IM, IN, IR, IT, JE, JP, KR, KW, NG, NZ, PK, PS, PT, RU, SE, SG, SY, US
250   - New countries: CO, LU, LY, MC, SM
251   - Addition of "Personal Number" ranges to all NANPA countries
252
253 Jan 31st, 2011
254 * Code changes:
255   - Introducing equals() and hashCode() methods for the Phonenumber.PhoneNumber class
256
257 Jan 28th, 2011
258 * Code changes:
259   - Fixing critical bug with non-Android-compatible code. isEmpty() was being used and CANON_EQ in
260     reg-ex matches.
261
262 Jan 20th, 2011
263 * Code improvements:
264   - Handle null phone-numbers when parsing by throwing a NumberParseException.
265   - Handle extension written with an accented "o", as per Spanish, when parsing.
266   - Handle U+30FC dashes as phone-number punctuation.
267   - Allow "ZZ" or null regions to be specified for numbers starting with a full-width "+" symbol, or
268     with other characters (such as whitespace) before the leading +.
269   - new getLengthOfNationalDestinationCode function
270 * Metadata changes:
271   - New types of numbers introduced: UAN (universal or "company" numbers) and short codes. Note that
272     "generalDesc" patterns do not encompass short-codes.  No code-support for these has been
273     introduced as of yet. We are also now enabling the collection of data for information such as
274     area-code-optional, and no-international-dialling ranges.
275   - Data updates as per ITU notifications/bug fixes for the following countries: AM, BH, CD, CG, CR,
276     DE, DJ, EE, GB, GN, HU, IE, JO, JP, LB, LR, MA, MK, MN, MR, NA, PG, SC, SG, SO, SZ, VN, ZA, ZW
277   - Data added for the following countries: BZ, CU, EC, FO, GI, HN, HT, LK, MT, MV, NU, PS, SD
278   - Indentation fixes in reg-exes for the following countries: BG, GB
279   - Allow nationalPrefixForParsing to be specified for countries with no national prefix, to handle
280     possible carrier prefixes
281
282 Jan 3rd, 2011
283 * Metadata changes:
284   - Updates to JE
285   - Updated comments for GB/GG/IM/JE
286
287 November 25th, 2010
288 * Metadata changes:
289   - Updates to existing countries: AD, AG, AI, AN, AS, BB, BG, BM, BS, BW, CA, DM, DO, GD, GH, GM,
290     GU, IN, JM, KN, KY, KZ, LB, LC, MP, MS, PR, SY, TC, TT, TZ, US, VC, VG, VI.
291   - Reorganize reg-exes for better readability.
292   - Updated comments.
293
294 October 22nd, 2010
295 * Metadata changes:
296   - Updates to existing countries: AE, GB, GG, IM, JE
297
298 October 15th, 2010
299 * Code improvements:
300   - Allowed parsing of numbers that start with "++" or a full-width "+" symbol
301   - Allowed reg-exes for national and possible number patterns to have white space in them in the
302     source XML file
303   - Added a more useful toString method for the phone number proto class
304 * Metadata changes:
305   - Updates to existing countries: AF, BF, BO, ES, GB, GG, IM, IS, JE, JE, JP, KR, PE, PT, RU, SE,
306     TT, ZW
307 * Bug fixes:
308   - Parsing empty strings with invalid region codes no longer throws a null pointer exception
309
310 September 4th, 2010
311 * Code improvement:
312   - Added new phone number type: pager
313 * Metadata change:
314   - update to existing country: GG, IM, JE, RS, RU
315 * Bug fixes:
316   - ArrayOutOfBoundException in AsYouTypeFormatter.getRememberedPosition()
317   - AsYouTypeFormatter for UK childline number
318
319 September 1st, 2010
320 * Bug fix on KZ metadata.
321
322 August 17th, 2010
323 * Code improvement:
324   - Refactored BuildMetadataProtoFromXml.java into BuildMetadataFromXml.java and
325     BuildMetadataProtoFromXml.java
326   - Added BuildMetadataProtoFromXml.java and JSArrayBuilder.java
327   - Refactored CountryCodeToRegionCodeMap and CountryCodeToRegionCodeMapForTesting into separate
328     files.
329
330 August 16th, 2010
331 * Bug fixes
332   - AsYouTypeFormatter for formatting Chinese geographical numbers entered in national format.
333   - AsYouTypeFormatter for formatting Chinese 400/800 numbers entered in national format.
334 * Metadata change:
335   - new countries: AM, AN, BH, GL, IS
336   - adding national prefix 1 to all NANPA countries.
337   - update to existing countries: BF, FR, UK, PK, RE
338
339 August 4th, 2010
340 * Further improve startup performance
341   - Preload no country specific metadata at startup.
342   - Stop creating the file containing mapping from country calling code to region code
343     and loading it at startup; instead, do the initialization in PhoneNumberUtil.
344
345 July 31th, 2010
346
347 * Improve startup performance
348   - Separate generated metadata binary file to one file per region
349   - Preload US at start up, and load other region at the time when needed
350   - Create a file containing mapping from country calling code to region code,
351     and load it at startup
352   - Same change also applied to unittests
353
354 July 30th, 2010
355 * Metadata change:
356   - new country: TL
357   - update to existing country: AZ, CN, FR, GH, JO, LA, PG, PK, QA, SZ, UA, VN
358
359 * Code improvement
360   - China local number formatting for AsYouTypeFormatter
361   - improve extension parsing to handle number in the form of +1 (645) 123 1234 ext. 910#