]> gitweb.fperrin.net Git - Dictionary.git/blob - jars/icu4j-4_4_2-src/readme.html
go
[Dictionary.git] / jars / icu4j-4_4_2-src / readme.html
1 <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">\r
2 <html>\r
3 <head>\r
4   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">\r
5   <meta http-equiv="Content-Style-Type" content="text/css2">\r
6   <title>ReadMe for ICU4J</title>\r
7   <meta name="COPYRIGHT" content="Copyright 2000-2010, International Business Machines Corporation and others. All Rights Reserved.">\r
8   <style type="text/css">\r
9 h3.doc { background: #CCCCFF }\r
10 h4.doc { text-decoration: underline }\r
11   </style>\r
12 </head>\r
13 <body style="background-color: rgb(255, 255, 255);" lang="EN-US"\r
14  link="#0000ff" vlink="#800080">\r
15 <h2>International Components for Unicode for Java (ICU4J)</h2>\r
16 <h3>Read Me for ICU4J 4.4.2</h3>\r
17 <hr size="2" width="100%">\r
18 <p><b>Release Date</b><br>\r
19 October 1, 2010<br>\r
20 </p>\r
21 \r
22 <p><b>Note:</b> This is an update release of ICU4J 4.4.  This release contains\r
23 several bug fixes and updated data, but does not introduce any new APIs or\r
24 functionalities.\r
25 </p>\r
26 <p>For the most recent release, see the <a\r
27  href="http://www.icu-project.org/download/"> ICU4J\r
28 download site</a>. </p>\r
29 <h3 class="doc">Contents</h3>\r
30 <ul type="disc">\r
31   <li><a href="#introduction">Introduction to ICU4J</a></li>\r
32   <li><a href="#changes">Changes In This Release</a></li>\r
33   <li><a href="#license">License Information</a></li>\r
34   <li><a href="#PlatformDependencies">Platform Dependencies</a></li>\r
35   <li><a href="#download">How to Download ICU4J</a></li>\r
36   <li><a href="#WhatContain">The Structure and Contents of ICU4J</a></li>\r
37   <li><a href="#API">Where to Get Documentation</a></li>\r
38   <li><a href="#HowToInstallJavac">How to Install and Build</a></li>\r
39   <li><a href="#HowToModularize">How to modularize ICU4J</a></li>\r
40   <li><a href="#tryingout">Trying Out ICU4J</a></li>\r
41   <li><a href="#resources">ICU4J Resource Information</a></li>\r
42   <li><a href="#timezone">About ICU4J Time Zone</a></li>\r
43   <li><a href="#WhereToFindMore">Where to Find More Information</a></li>\r
44   <li><a href="#SubmittingComments">Submitting Comments, Requesting\r
45 Features and Reporting Bugs</a></li>\r
46 </ul>\r
47 <h3 class="doc"><a name="introduction"></a>Introduction to ICU4J</h3>\r
48 <p>The International Components for Unicode (ICU) library provides\r
49 robust and\r
50 full-featured Unicode services on a wide variety of platforms. ICU\r
51 supports the\r
52 most current version of the Unicode standard, including support for\r
53 supplementary characters (needed for GB 18030 repertoire support).</p>\r
54 <p>Java provides a strong foundation for global programs, and IBM and\r
55 the\r
56 ICU team played a key role in providing globalization technology to\r
57 Java. But because of its long release schedule, Java cannot always keep\r
58 up with evolving standards. The ICU team continues to extend Java's\r
59 Unicode and internationalization support, focusing on improving\r
60 performance,\r
61 keeping current with the Unicode standard, and providing richer APIs,\r
62 while\r
63 remaining as compatible as possible with the original Java text and\r
64 internationalization API design.</p>\r
65 <p>ICU4J is an add-on to the regular JRE that provides:\r
66 </p>\r
67 <ul>\r
68   <li><a\r
69  href="http://www.icu-project.org/userguide/Collate_Intro.html"><b>Collation</b></a>\r
70 &#8211; rule-based, up-to-date Unicode Collation Algorithm (UCA) sorting order<br>\r
71 &nbsp;&nbsp;&nbsp;&nbsp;For fast multilingual string comparison; faster\r
72 and more complete than\r
73 the J2SE implementation</li>\r
74   <li><a href="http://www.icu-project.org/userguide/strings.html"><b>Supplementary\r
75 Characters</b></a> &#8211; String manipulation and character properties<br>\r
76 &nbsp;&nbsp;&nbsp;&nbsp;Required for proper GB 18030 and JIS X 0213\r
77 repertoire support</li>\r
78   <li><a href="http://www.icu-project.org/userguide/charsetDetection.html"><b>Charset\r
79 Detection</b></a> &#8211; Recognition of various single and multibyte charsets<br>\r
80 &nbsp;&nbsp;&nbsp;&nbsp;Useful for recognizing untagged text data</li>\r
81   <li><a\r
82  href="http://www.icu-project.org/userguide/unicodeSet.html"><b>UnicodeSet</b></a>\r
83 &#8211; standard set operations optimized for sets of Unicode characters<br>\r
84 &nbsp;&nbsp;&nbsp;&nbsp;UnicodeSets can be built from string patterns\r
85 using any Unicode properties.</li>\r
86   <li><a href="http://www.icu-project.org/userguide/Transform.html"><b>Transforms</b></a>\r
87 &#8211; a flexible mechanism for Unicode text conversions<br>\r
88 &nbsp;&nbsp;&nbsp;&nbsp;Including Full/Halfwidth conversions,\r
89 Normalization, Case conversions, Hex\r
90 conversions, and transliterations between scripts (50+ pairs)</li>\r
91   <li><a\r
92  href="http://www.icu-project.org/userguide/normalization.html"><b>Unicode\r
93 Normalization</b></a> &#8211; NFC, NFD, NFKD, NFKC<br>\r
94 &nbsp;&nbsp;&nbsp;&nbsp;For canonical text representations, needed for\r
95 XML and the net</li>\r
96   <li><a\r
97  href="http://www.icu-project.org/userguide/dateCalendar.html"><b>International\r
98 Calendars</b></a> &#8211; Arabic, Buddhist, Chinese, Hebrew, Japanese, Ethiopic, Islamic, Coptic and other calendars<br>\r
99 &nbsp;&nbsp;&nbsp;&nbsp;Required for correct presentation of dates in\r
100 certain countries</li>\r
101   <li><a\r
102  href="http://www.icu-project.org/userguide/formatNumbers.html"><b>Number\r
103 Format\r
104 Enhancements</b></a> &#8211; Scientific Notation, Spelled-out, etc.<br>\r
105 &nbsp;&nbsp;&nbsp;&nbsp;Enhancements to the normal Java number\r
106 formatting. The spell-out format is\r
107 used for checks and similar documents</li>\r
108   <li><a\r
109  href="http://www.icu-project.org/userguide/boundaryAnalysis.html"><b>Enhanced\r
110 Word-Break Detection</b></a> &#8211; Rule-based, supports Thai<br>\r
111 &nbsp;&nbsp;&nbsp;&nbsp;Required for correct support of Thai</li>\r
112   <li><a\r
113  href="http://www.icu-project.org/userguide/compression.html"><b>Unicode\r
114 Text\r
115 Compression</b></a> &#8211; Standard compression of Unicode text<br>\r
116 &nbsp;&nbsp;&nbsp;&nbsp;Suitable for large numbers of small fields,\r
117 where LZW and similar schemes\r
118 do not apply</li>\r
119   <li><a\r
120  href="http://www.icu-project.org/userguide/conversion.html"><b>Charset Conversion</b></a> &#8211; Conversion to and from different charsets.<br>\r
121 &nbsp;&nbsp;&nbsp;&nbsp;Plugs into Java CharsetProvider Service Provider Interface (SPI)</li>\r
122 \r
123 </ul>\r
124 <blockquote>\r
125   <p><b>Note:</b> We continue to provide assistance to Sun, and in some\r
126 cases, ICU4J support has been rolled into a later release of Java. For\r
127 example, the Thai word-break is now in Java 1.4. However, the most\r
128 current and complete version is always found in ICU4J.</p>\r
129 </blockquote>\r
130 \r
131 <h3 class="doc"><a name="changes"></a>Changes In This Release</h3>\r
132 <h4>Minimum Java runtime environment requirement</h4>\r
133 <p>\r
134 Starting with version 4.4, you need at least JRE 5.0 to use ICU4J 4.4.\r
135 ICU4J adopted Java 5 language features and no longer compiles with JDK 1.4 or\r
136 older versions.  This migration also includes some updates in public API signatures,\r
137 such as generics and return/parameter types.  In general, most of these changes\r
138 do not require any changes in existing ICU4J user code.\r
139 </p>\r
140 \r
141 <h4>TimeZone serialization compatibility</h4>\r
142 <p>\r
143 The new system time zone data format supporting 64bit transition time data\r
144 implemented in ICU4J 4.4 introduced a serialization incompatibility issue\r
145 in the internal TimeZone implementation class (e.g. An instance of TimeZone\r
146 created by <code>TimeZone.getTimeZone(String)</code> with an Olson tzid, such as\r
147 <code>"America/Los_Angeles"</code>).\r
148 \r
149 The new implementation reads only the system time zone identifier string\r
150 when object data was serialized by ICU4J 4.2 or older versions.  Also, ICU4J\r
151 4.2 or older versions cannot read object data created by ICU4J 4.4.\r
152 \r
153 The system time zone implementation class may be used by other ICU4J\r
154 public API classes, such as <code>Calendar</code> and <code>DateFormat</code>,\r
155 therefore, these classes are also affected.\r
156 </p>\r
157 <p>\r
158 For the ICU4J serialization compatibility policy, please refer the user guide section\r
159 <a href="http://userguide.icu-project.org/design#TOC-ICU4J-Serialization-Compatibility">ICU4J\r
160 Serialization Compatibility</a>.\r
161 </p>\r
162 \r
163 <h4>New features and other changes</h4>\r
164 <p>\r
165 See the <a href="http://icu-project.org/download/4.4.html">ICU 4.4 download page</a> about\r
166 new features in this release.  The list of API changes since the previous ICU4J release\r
167 is available\r
168 <a href="http://source.icu-project.org/repos/icu/icu4j/tags/release-4-4/APIChangeReport.html">here</a>.\r
169 </p>\r
170 \r
171 <h4 class="doc">Summary of updates in 4.4.2 (October 1, 2010)</h4>\r
172 <p><b>Tme zone data update</b></p>\r
173 <p>ICU4J 4.4.2 updates the time zone data to version\r
174 <a href="http://source.icu-project.org/repos/icu/data/trunk/tzdata/icunew/2010m/44/">2010m</a>\r
175 from the Olson tz database.</p>\r
176 \r
177 <p><b>Bug fix</b></p>\r
178 <p>This release contains following bug fix\r
179 <ul>\r
180 <li><a href="http://bugs.icu-project.org/trac/ticket/7922">#7922</a> ICU4J charset converter aliases do not work on z/OS</li>\r
181 <li><a href="http://bugs.icu-project.org/trac/ticket/7927">#7927</a> Updated LMBCS mapping table</li>\r
182 <li><a href="http://bugs.icu-project.org/trac/ticket/7941">#7941</a> CopticTest/Test6379 failure</li>\r
183 </ul>\r
184 </p>\r
185 \r
186 <h4 class="doc">Summary of updates in 4.4.1.1 (June 21, 2010)</h4>\r
187 <p><b>Tme zone data update</b></p>\r
188 <p>ICU4J 4.4.1.1 updates the time zone data to version\r
189 <a href="http://source.icu-project.org/repos/icu/data/trunk/tzdata/icunew/2010j/44/">2010j</a>\r
190 from the Olson tz database.</p>\r
191 \r
192 <p><b>Bug fix</b></p>\r
193 <p>This release contains following bug fix\r
194 <ul>\r
195 <li><a href="http://bugs.icu-project.org/trac/ticket/7765">#7765</a> ICU4J 4.4 fails to load available locales on WebSphere</li>\r
196 </ul>\r
197 </p>\r
198 \r
199 <h4 class="doc">Summary of updates in 4.4.1 (April 28, 2010)</h4>\r
200 <p><b>CLDR 1.8.1 updates</b></p>\r
201 <p>ICU4J 4.4.1 imported locale data updates from <a href="http://cldr.unicode.org/index/downloads/cldr-1-8-1">CLDR\r
202 1.8.1</a> release.\r
203 \r
204 <p><b>Time zone data update</b></p>\r
205 <p>ICU4J 4.4.1 updates the time zone data to version\r
206 <a href="http://source.icu-project.org/repos/icu/data/trunk/tzdata/icunew/2010i/44/">2010i</a>\r
207 from the Olson tz database.</p>\r
208 \r
209 <p><b>Bug fixes</b></p>\r
210 <p>This release contains following bug fixes\r
211 <ul>\r
212 <li><a href="http://bugs.icu-project.org/trac/ticket/7395">#7395</a> gatherapi tool doesn't handle 'synthetic' methods</li>\r
213 <li><a href="http://bugs.icu-project.org/trac/ticket/7594">#7594</a> Serialization CoverageTest is broken in ICU 4.4</li>\r
214 <li><a href="http://bugs.icu-project.org/trac/ticket/7595">#7595</a> SimpleDateFormat fails to handle very long field patterns</li>\r
215 <li><a href="http://bugs.icu-project.org/trac/ticket/7644">#7644</a> Enable non-Gregorian calendars for DateIntervalFormat</li>\r
216 </ul>\r
217 \r
218 <h3 class="doc"><a name="license"></a>License Information</h3>\r
219 <p>\r
220 The ICU projects (ICU4C and ICU4J) use the X license. The X\r
221 license is <b>suitable for commercial use</b> and is a recommended free software license\r
222 that is compatible with the GNU GPL license. This became\r
223 effective with release 1.8.1 of ICU4C and release 1.3.1 of ICU4J in\r
224 mid-2001. All new ICU releases will adopt the X license; previous ICU\r
225 releases continue to utilize the IPL (IBM Public License). Users\r
226 of previous releases of ICU who want to adopt new ICU releases will\r
227 need to accept the terms and conditions of the X license.\r
228 </p>\r
229 <p>\r
230 The main effect of the change is to provide GPL compatibility.\r
231 The X license is listed as GPL compatible, see the GNU page at \r
232 <a href="http://www.gnu.org/philosophy/license-list.html#GPLCompatibleLicenses">\r
233 http://www.gnu.org/philosophy/license-list.html#GPLCompatibleLicenses</a>.\r
234 This means that GPL projects can now use ICU code, it does <b>not</b>\r
235 mean that projects using ICU become subject to GPL.\r
236 </p>\r
237 <p>\r
238  The IBM version contains the essential text of the license, omitting the\r
239 X-specific trademarks and copyright notices. The full copy of <a\r
240  href="main/shared/licenses/license.html">ICU's license</a> is included in the download\r
241 package.\r
242 </p>\r
243 <h3 class="doc"><a name="PlatformDependencies"></a>Platform Dependencies</h3>\r
244 <p>\r
245 ICU4J 4.4 depends on J2SE 5.0 functionality.  Therefore, ICU4J only runs on\r
246 JRE version 5.0 or later.\r
247 The table below shows the operating systems and JRE/VM versions currently\r
248 used by the ICU development team to test ICU4J.\r
249 </p>\r
250 <table border="1">\r
251 <tr>\r
252   <th rowspan="3">Operating System</th>\r
253   <th colspan="4">JRE/Hotspot</th>\r
254   <th colspan="4">JRE/IBM J9</th>\r
255 </tr>\r
256 <tr>\r
257   <th colspan="2">1.6.0</th>\r
258   <th colspan="2">1.5.0</th>\r
259   <th colspan="2">1.6.0</th>\r
260   <th colspan="2">1.5.0</th>\r
261 </tr>\r
262 <tr>\r
263   <th>32bit</th>\r
264   <th>64bit</th>\r
265   <th>32bit</th>\r
266   <th>64bit</th>\r
267   <th>32bit</th>\r
268   <th>64bit</th>\r
269   <th>32bit</th>\r
270   <th>64bit</th>\r
271 </tr>\r
272 <tr>\r
273   <th>AIX 5.3</th>\r
274   <td align="center">-</td>\r
275   <td align="center">-</td>\r
276   <td align="center">-</td>\r
277   <td align="center">-</td>\r
278   <td align="center">-</td>\r
279   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
280   <td align="center">-</td>\r
281   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
282 </tr>\r
283 <tr>\r
284   <th>AIX 6.1</th>\r
285   <td align="center">-</td>\r
286   <td align="center">-</td>\r
287   <td align="center">-</td>\r
288   <td align="center">-</td>\r
289   <td align="center">-</td>\r
290   <td align="center" bgcolor="#CCCCFF"><em><b>Reference platform</b></em></td>\r
291   <td align="center">-</td>\r
292   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
293 </tr>\r
294 <tr>\r
295   <th>HP-UX 11 (PA-RISC)</th>\r
296   <td align="center">-</td>\r
297   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
298   <td align="center">-</td>\r
299   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
300   <td align="center">-</td>\r
301   <td align="center">-</td>\r
302   <td align="center">-</td>\r
303   <td align="center">-</td>\r
304 </tr>\r
305 <tr>\r
306   <th>HP-UX 11 (IA64)</th>\r
307   <td align="center">-</td>\r
308   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
309   <td align="center">-</td>\r
310   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
311   <td align="center">-</td>\r
312   <td align="center">-</td>\r
313   <td align="center">-</td>\r
314   <td align="center">-</td>\r
315 </tr>\r
316 <tr>\r
317   <th>Mac OS X 10.5</th>\r
318   <td align="center">-</td>\r
319   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
320   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
321   <td align="center">-</td>\r
322   <td align="center">-</td>\r
323   <td align="center">-</td>\r
324   <td align="center">-</td>\r
325   <td align="center">-</td>\r
326 </tr>\r
327 <tr>\r
328   <th>Redhat Enterprise Linux 5 (x86)</th>\r
329   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
330   <td align="center">-</td>\r
331   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
332   <td align="center">-</td>\r
333   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
334   <td align="center">-</td>\r
335   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
336   <td align="center">-</td>\r
337 </tr>\r
338 <tr>\r
339   <th>Redhat Enterprise Linux 5 (x86_64)</th>\r
340   <td align="center">-</td>\r
341   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
342   <td align="center">-</td>\r
343   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
344   <td align="center">-</td>\r
345   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
346   <td align="center">-</td>\r
347   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
348 </tr>\r
349 <tr>\r
350   <th>Solaris 9 (SPARC)</th>\r
351   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
352   <td align="center">-</td>\r
353   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
354   <td align="center">-</td>\r
355   <td align="center">-</td>\r
356   <td align="center">-</td>\r
357   <td align="center">-</td>\r
358   <td align="center">-</td>\r
359 </tr>\r
360 <tr>\r
361   <th>Solaris 10 (SPARC)</th>\r
362   <td align="center">-</td>\r
363   <td align="center" bgcolor="#CCCCFF"><em><b>Reference platform</b></em></td>\r
364   <td align="center">-</td>\r
365   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
366   <td align="center">-</td>\r
367   <td align="center">-</td>\r
368   <td align="center">-</td>\r
369   <td align="center">-</td>\r
370 </tr>\r
371 <tr>\r
372   <th>Windows XP</th>\r
373   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
374   <td align="center">-</td>\r
375   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
376   <td align="center">-</td>\r
377   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
378   <td align="center">-</td>\r
379   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
380   <td align="center">-</td>\r
381 </tr>\r
382 <tr>\r
383   <th>Windows Vista</th>\r
384   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
385   <td align="center">-</td>\r
386   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
387   <td align="center">-</td>\r
388   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
389   <td align="center">-</td>\r
390   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
391   <td align="center">-</td>\r
392 </tr>\r
393 <tr>\r
394   <th>Windows 7</th>\r
395   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
396   <td align="center">-</td>\r
397   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
398   <td align="center">-</td>\r
399   <td align="center" bgcolor="#CCCCFF"><em><b>Reference platform</b></em></td>\r
400   <td align="center">-</td>\r
401   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
402   <td align="center">-</td>\r
403 </tr>\r
404 <tr>\r
405   <th>Windows 2008 Server</th>\r
406   <td align="center">-</td>\r
407   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
408   <td align="center">-</td>\r
409   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
410   <td align="center">-</td>\r
411   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
412   <td align="center">-</td>\r
413   <td align="center" bgcolor="#DDDDFF">Regularly tested</td>\r
414 </tr>\r
415 </table>\r
416 \r
417 <h3 class="doc"><a name="download"></a>How to Download ICU4J</h3>\r
418 <p>There are two ways to download the ICU4J releases.\r
419 </p>\r
420 <ul type="disc">\r
421   <li><b>Official Release:</b><br>\r
422 If you want to use ICU4J (as opposed to developing it), your best bet\r
423 is to download an official, packaged version of the ICU4J library files.\r
424 These versions are tested more thoroughly than day-to-day development\r
425 builds, and they are packaged in jar files for convenient download.\r
426 These packaged files can be found at the\r
427 <a href="http://www.icu-project.org/download/">ICU Download page</a>.\r
428 </li></ul>\r
429 <ul type="disc">\r
430   <li><b>Subversion Source Repository:</b><br>\r
431 If you are interested in developing features, patches, or bug fixes for\r
432 ICU4J, you should probably be working with the latest version of the\r
433 ICU4J source code. You will need to check the code out of our Subversion\r
434 repository to ensure that you have the most recent version of all of\r
435 the files. There are several ways to do this. Please follow the\r
436 directions that are contained on the <a\r
437  href="http://www.icu-project.org/repository/">Source\r
438  Repository page</a> for details.\r
439   </li>\r
440 </ul>\r
441 <p>For more details on how to download ICU4J directly from the web\r
442 site, please see the ICU download page at <a\r
443  href="http://www.icu-project.org/download/">http://www.icu-project.org/download/</a>\r
444 </p>\r
445 <h3 class="doc"><a name="WhatContain"></a>The Structure and Contents of\r
446 ICU4J</h3>\r
447 <p>Below, all directory pathes are relative to the directory where the\r
448 ICU4J source archive is extracted.\r
449 </p>\r
450 <p><b>Information and build files:</b></p>\r
451 <table border="1">\r
452 <tr>\r
453   <th>Path</th>\r
454   <th>Description</th>\r
455 </tr>\r
456 <tr>\r
457   <td>readme.html</td>\r
458   <td>A description of ICU4J (International Components for Unicode for Java)</td>\r
459 </tr>\r
460 <tr>\r
461   <td>build.html</td>\r
462   <td>The main Ant build file for ICU4J.  See <a href="#HowToInstallJavac">How to Install\r
463   and Build</a> for more information</td>\r
464 </tr>\r
465 <tr>\r
466   <td>main/shared/licenses/license.html</td>\r
467   <td>The X license, used by ICU4J</td>\r
468 </tr>\r
469 </table>\r
470 \r
471 <p><b>ICU4J runtime class files:</b></p>\r
472 <table border="1">\r
473 <tr>\r
474   <th>Path</th>\r
475   <th>Sub-component Name</th>\r
476   <th>Build Dependencies</th>\r
477   <th>Public API Packages</th>\r
478   <th>Description</th>\r
479 </tr>\r
480 <tr>\r
481   <td>main/classes/charset</td>\r
482   <td>icu4j-charset</td>\r
483   <td>icu4j-core</td>\r
484   <td>com.ibm.icu.charset</td>\r
485   <td>Implementation of <code>java.nio.charset.spi.CharsetProvider</code>.\r
486   This sub-component is shipped as icu4j-charsets.jar along with\r
487   ICU charset converter data files.</td>\r
488 </tr>\r
489 <tr>\r
490   <td>main/classes/collate</td>\r
491   <td>icu4j-collate</td>\r
492   <td>icu4j-core</td>\r
493   <td>com.ibm.icu.text<br>\r
494   com.ibm.icu.util</td>\r
495   <td>Collator APIs and implementation.  Also includes some public API classes\r
496   that depend on Collator.\r
497   This sub-component is packaged as a part of icu4j.jar.</td>\r
498 </tr>\r
499 <tr>\r
500   <td>main/classes/core</td>\r
501   <td>icu4j-core</td>\r
502   <td>n/a</td>\r
503   <td>com.ibm.icu.lang<br>\r
504   com.ibm.icu.math<br>\r
505   com.ibm.icu.text<br>\r
506   com.ibm.icu.util</td>\r
507   <td>ICU core API classes and implementation.\r
508   This sub-component is packaged as a part of icu4j.jar.</td>\r
509 </tr>\r
510 <tr>\r
511   <td>main/classes/currdata</td>\r
512   <td>icu4j-currdata</td>\r
513   <td>icu4j-core</td>\r
514   <td>n/a</td>\r
515   <td>No public API classes.  Provides access to currency display data.\r
516   This sub-component is packaged as a part of icu4j.jar.</td>\r
517 </tr>\r
518 <tr>\r
519   <td>main/classes/langdata</td>\r
520   <td>icu4j-langdata</td>\r
521   <td>icu4j-core</td>\r
522   <td>n/a</td>\r
523   <td>No public API classes.  Provides access to language display data.\r
524   This sub-component is packaged as a part of icu4j.jar.</td>\r
525 </tr>\r
526 <tr>\r
527   <td>main/classes/localespi</td>\r
528   <td>icu4j-localespi</code>\r
529   <td>icu4j-core<br>\r
530   icu4j-collate<br>\r
531   </td>\r
532   <td>n/a</td>\r
533   <td>Implementation of various locale-sensitive service providers defined\r
534   in <code>java.text.spi</code> and <code>java.util.spi</code> in J2SE 6.0\r
535   or later Java releases.\r
536   This sub-component is shipped as icu4j-localespi.jar.</td>\r
537 </tr>\r
538 <tr>\r
539   <td>main/classes/regiondata</td>\r
540   <td>icu4j-regiondata</td>\r
541   <td>icu4j-core</td>\r
542   <td>n/a</td>\r
543   <td>No public API classes.  Provides access to region display data.\r
544   This sub-component is packaged as a part of icu4j.jar.</td>\r
545 </tr>\r
546 <tr>\r
547   <td>main/classes/translit</td>\r
548   <td>icu4j-translit</td>\r
549   <td>icu4j-core</td>\r
550   <td>com.ibm.icu.text</td>\r
551   <td>Transliterator APIs and implementation.\r
552   This sub-component is packaged as a part of icu4j.jar.</td>\r
553 </tr>\r
554 </table>\r
555 \r
556 <p><b>ICU4J unit test files:</b></p>\r
557 <table border="1">\r
558 <tr>\r
559   <th>Path</th>\r
560   <th>Sub-component Name</th>\r
561   <th>Runtime Dependencies</th>\r
562   <th>Description</th>\r
563 </tr>\r
564 <tr>\r
565   <td>main/tests/charset</td>\r
566   <td>icu4j-charset-tests</td>\r
567   <td>icu4j-charset<br>\r
568   icu4j-core<br>\r
569   icu4j-test-framework</td>\r
570   <td>Test suite for charset sub-component.</td>\r
571 </tr>\r
572 <tr>\r
573   <td>main/tests/collate</td>\r
574   <td>icu4j-collate-tests</td>\r
575   <td>icu4j-collate<br>\r
576   icu4j-core<br>\r
577   icu4j-test-framework</td>\r
578   <td>Test suite for collate sub-component.</td>\r
579 </tr>\r
580 <tr>\r
581   <td>main/tests/core</td>\r
582   <td>icu4j-core-tests</td>\r
583   <td>icu4j-core<br>\r
584   icu4j-currdata<br>\r
585   icu4j-langdata<br>\r
586   icu4j-regiondata<br>\r
587   icu4j-test-framework</td>\r
588   <td>Test suite for core sub-component.</td>\r
589 </tr>\r
590 <tr>\r
591   <td>main/tests/framework</td>\r
592   <td>icu4j-test-framework</td>\r
593   <td>icu4j-core</td>\r
594   <td>Common ICU4J unit test framework and utilities.</td>\r
595 </tr>\r
596 <tr>\r
597   <td>main/tests/localespi</td>\r
598   <td>icu4j-localespi-tests</td>\r
599   <td>icu4j-core<br>\r
600   icu4j-collate<br>\r
601   icu4j-currdata<br>\r
602   icu4j-langdata<br>\r
603   icu4j-localespi<br>\r
604   icu4j-regiondata<br>\r
605   icu4j-test-framework</td>\r
606   <td>Test suite for localespi sub-component.</td>\r
607 </tr>\r
608 <tr>\r
609   <td>main/tests/packaging</td>\r
610   <td>icu4j-packaging-tests</td>\r
611   <td>icu4j-core<br>\r
612   icu4j-test-framework</td>\r
613   <td>Test suite for sub-component packaging.</td>\r
614 </tr>\r
615 <tr>\r
616   <td>main/tests/translit</td>\r
617   <td>icu4j-translit-tests</td>\r
618   <td>icu4j-core<br>\r
619   icu4j-translit\r
620   icu4j-test-framework</td>\r
621   <td>Test suite for translit sub-component.</td>\r
622 </tr>\r
623 </table>\r
624 \r
625 <p><b>Others:</b></p>\r
626 <table border="1">\r
627 <tr>\r
628   <th>Path</td>\r
629   <th>Description</td>\r
630 </tr>\r
631 <tr>\r
632   <td>main/shared</td>\r
633   <td>Files shared by ICU4J sub-components under the <code>main</code> directory including:\r
634   <ul>\r
635     <li>ICU4J runtime data archive (icudata.jar).<li>\r
636     <li>ICU4J unit test data archive (testdata.jar).<li>\r
637     <li>Shared Ant build script and configuration files.</li>\r
638     <li>License files.</li>\r
639   </ul>\r
640   </td>\r
641 </tr>\r
642 <tr>\r
643   <td>demos</td>\r
644   <td>ICU4J demo programs.</td>\r
645 </tr>\r
646 <tr>\r
647   <td>perf-tests</td>\r
648   <td>ICU4J performance test files.</td>\r
649 </tr>\r
650 <tr>\r
651   <td>tools</td>\r
652   <td>ICU4J tools including:\r
653   <ul>\r
654     <li>Custom JavaDoc taglets used for generating ICU4J API references.</li>\r
655     <li>API report tool and data.</li>\r
656     <li>Other independent utilities used for ICU4J development.</li>\r
657   </ul>\r
658   </td>\r
659 </tr>\r
660 </table>\r
661 \r
662 <h3 class="doc"><a name="API"></a>Where to get Documentation</h3>\r
663 <p>The <a href="http://www.icu-project.org/userguide/">ICU user's\r
664 guide</a> contains lots of general information about ICU, in its C,\r
665 C++, and Java incarnations.</p>\r
666 <p>The complete API documentation for ICU4J (javadoc) is available on\r
667 the ICU4J web site, and can be built from the sources:\r
668 </p>\r
669 <ul>\r
670   <li><a href="http://www.icu-project.org/apiref/icu4j/">Index\r
671 to all ICU4J API</a></li>\r
672   <li><a href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/text/CharsetDetector.html">Charset Detector</a> &#8211; Detection of charset from a byte stream</li>\r
673   <li>International Calendars &#8211; \r
674     <a\r
675  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/util/BuddhistCalendar.html">Buddhist</a>,\r
676     <a\r
677  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/util/ChineseCalendar.html">Chinese</a>,\r
678     <a\r
679  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/util/CopticCalendar.html">Coptic</a>,\r
680     <a\r
681  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/util/EthiopicCalendar.html">Ethiopic</a>,\r
682     <a\r
683  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/util/GregorianCalendar.html">Gregorian</a>,\r
684     <a\r
685  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/util/HebrewCalendar.html">Hebrew</a>,\r
686     <a\r
687  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/util/IndianCalendar.html">Indian</a>,\r
688     <a\r
689  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/util/IslamicCalendar.html">Islamic</a>,\r
690     <a\r
691  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/util/JapaneseCalendar.html">Japanese</a>.</li>\r
692   <li><a\r
693  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/text/Normalizer.html">Unicode\r
694 Normalization</a> &#8211; Canonical text representation for W3C.</li>\r
695   <li><a\r
696  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/text/NumberFormat.html">Number\r
697 Format Enhancements</a> &#8211; Scientific Notation, Spelled out.</li>\r
698   <li><a\r
699  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/text/BreakIterator.html">Enhanced\r
700 word-break detection</a> &#8211; Rule-based, supports Thai</li>\r
701   <li><a\r
702  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/text/Transliterator.html">Transliteration</a>\r
703 &#8211; A general framework for converting text from one format to another,\r
704 e.g. Cyrillic to Latin, or Hex to Unicode. </li>\r
705   <li>Unicode Text <a\r
706  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/text/UnicodeCompressor.html">Compression</a>\r
707 &amp; <a\r
708  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/text/UnicodeDecompressor.html">Decompression</a>\r
709 &#8211; 2:1 compression on English Unicode text.</li>\r
710   <li>Collation - <a\r
711  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/text/RuleBasedCollator.html">Rule-based\r
712 sorting</a>, <a\r
713  href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/text/StringSearch.html">Efficient\r
714 multi-lingual searching</a> </li>\r
715 </ul>\r
716 <h3 class="doc"><a name="HowToInstallJavac"></a>How to Install and Build</h3>\r
717 <p>\r
718 To install ICU4J, simply place the prebuilt jar file <strong>icu4j.jar</strong>\r
719 on your Java CLASSPATH. If you need Charset API support please also place\r
720 <strong>icu4j-charsets.jar</strong> on your class path along with <strong>icu4j.jar</strong>.\r
721 </p>\r
722 <p>\r
723 To build ICU4J, you will need J2SE SDK 5.0 or later (ICU4J locale SPI\r
724 provider sub-components require J2SE SDK 6.0 or later) and the Ant build system\r
725 version 1.7 or later. It's recommended to install both the J2SE SDK and Ant \r
726 somewhere <em>outside</em>the ICU4J directory. For example, on Linux you might install\r
727 these in <code>/usr/local</code>.</p>\r
728 <ul>\r
729   <li>Install J2SE SDK 6.0.</li>\r
730   <li>Install the <a href="http://ant.apache.org/"><strong>Ant</strong></a>\r
731   build system. Ant is a portable, Java-based build system similar to\r
732   make. ICU4J uses Ant because it introduces no other dependencies, it's\r
733   portable, and it's easier to manage than a collection of makefiles. We\r
734   currently build ICU4J using a single makefile on all platforms Ant.\r
735   The build system requires Ant 1.7 or later.\r
736     <p>Installing Ant is straightforward. Download it (see <a\r
737  href="http://ant.apache.org/bindownload.cgi">http://ant.apache.org/bindownload.cgi</a>),\r
738 extract it onto your system, set some environment variables, and add\r
739 its bin directory to your path. For example: </p>\r
740     <pre>\r
741         set JAVA_HOME=C:\jdk1.6.0\r
742         set ANT_HOME=C:\ant\r
743         set PATH=%PATH%;%ANT_HOME%\bin</pre>\r
744     <p>See the current Ant documentation for details.</p>\r
745   </li>\r
746 </ul>\r
747 <p>Once the J2SE SDK and Ant are installed, building is just a matter of\r
748 typing <strong>ant</strong> in the ICU4J root directory. This causes the\r
749 Ant build system to perform the build target <strong>jar</strong>\r
750 as specified by the file <strong>build.xml</strong>, located in the ICU4J\r
751 root directory. You can give Ant options like -verbose, and you can specify\r
752 other targets.  For example:</p>\r
753 <blockquote>\r
754 <pre>C:\icu4j>ant\r
755 Buildfile: build.xml\r
756 \r
757 info:\r
758      [echo] ----- Build Environment Information -------------------\r
759      [echo] Java Home:    C:\jdk1.6.0\r
760      [echo] Java Version: 1.6.0\r
761      [echo] Ant Home:     C:\ant\r
762      [echo] Ant Version:  Apache Ant version 1.7.1 compiled on June 27 2008\r
763      [echo] OS:           Windows Vista\r
764      [echo] OS Version:   6.1 build 7600\r
765      [echo] OS Arch:      x86\r
766      [echo] Host:         ICUDEV\r
767      [echo] -------------------------------------------------------\r
768 \r
769 core:\r
770 \r
771 @compile:\r
772      [echo] --- java compiler arguments ------------------------\r
773      [echo] source dir:     C:\icu4j\main\classes\core/src\r
774      [echo] output dir:     C:\icu4j\main\classes\core/out/bin\r
775      [echo] classpath:\r
776      [echo] source:         1.5\r
777      [echo] target:         1.5\r
778      [echo] debug:          on\r
779      [echo] encoding:       ascii\r
780      [echo] compiler arg:   -Xlint:all,-deprecation,-dep-ann\r
781      [echo] ----------------------------------------------------\r
782     [mkdir] Created dir: C:\icu4j\main\classes\core\out\bin\r
783     [javac] Compiling 316 source files to C:\icu4j\main\classes\core\out\bin\r
784     [javac] Note: Some input files use or override a deprecated API.\r
785     [javac] Note: Recompile with -Xlint:deprecation for details.\r
786 \r
787 compile:\r
788 \r
789 @copy:\r
790      [copy] Copying 23 files to C:\icu4j\main\classes\core\out\bin\r
791 \r
792 copy-data:\r
793     [unjar] Expanding: C:\icu4j\main\shared\data\icudata.jar into C:\icu4j\main\classes\core\out\bin\r
794 \r
795 ....\r
796 ....\r
797 ....\r
798 \r
799 build:\r
800 \r
801 _build-localespi:\r
802 \r
803 @compile:\r
804      [echo] --- java compiler arguments ------------------------\r
805      [echo] source dir:     C:\icu4j\main\classes\localespi/src\r
806      [echo] output dir:     C:\icu4j\main\classes\localespi/out/bin\r
807      [echo] classpath:      C:\icu4j\main\classes\core\out\lib\icu4j-core.jar;C:\icu4j\main\classes\collate\\r
808 out\lib\icu4j-collate.jar\r
809      [echo] source:         1.6\r
810      [echo] target:         1.6\r
811      [echo] debug:          on\r
812      [echo] encoding:       ascii\r
813      [echo] compiler arg:   -Xlint:all,-deprecation,-dep-ann\r
814      [echo] ----------------------------------------------------\r
815     [mkdir] Created dir: C:\icu4j\main\classes\localespi\out\bin\r
816     [javac] Compiling 22 source files to C:\icu4j\main\classes\localespi\out\bin\r
817 \r
818 compile:\r
819 \r
820 @copy:\r
821      [copy] Copying 10 files to C:\icu4j\main\classes\localespi\out\bin\r
822 \r
823 copy:\r
824 \r
825 @jar:\r
826     [mkdir] Created dir: C:\icu4j\main\classes\localespi\out\lib\r
827      [copy] Copying 1 file to C:\icu4j\main\classes\localespi\out\r
828       [jar] Building jar: C:\icu4j\main\classes\localespi\out\lib\icu4j-localespi.jar\r
829 \r
830 jar:\r
831 \r
832 build:\r
833 \r
834 jar:\r
835      [copy] Copying 1 file to C:\icu4j\r
836      [copy] Copying 1 file to C:\icu4j\r
837 \r
838 BUILD SUCCESSFUL\r
839 Total time: 24 seconds</pre>\r
840 </blockquote>\r
841 <I>Note: The above output is an example. The numbers are likely to be different with the current version ICU4J.</I>\r
842 <p>The following are some targets that you can provide to <b>ant</b>.\r
843 For more targets run <code>ant -projecthelp</code> or see the build.xml file.</p>\r
844 <table border="1">\r
845 <tr>\r
846   <th>jar (default)</th>\r
847   <td>Create ICU4J runtime library jar archives (<code>icu4j.jar</code>, \r
848   <code>icu4j-charsets.jar</code> and <code>icu4j-localespi.jar</code>)\r
849   in the root ICU4J directory.</td>\r
850 </tr>\r
851 <tr>\r
852   <th>check</th>\r
853   <td>Build all ICU4J runtime library classes and corresponding unit test cases,\r
854   then run the tests.</td>\r
855 </tr>\r
856 <tr>\r
857   <th>clean</th>\r
858   <td>Remove all build output files.</td>\r
859 </tr>\r
860 <tr>\r
861   <th>main</th>\r
862   <td>Build all ICU4J runtime library sub-components (under the directory\r
863   <code>main/classes</code>).</td>\r
864 </tr>\r
865 <tr>\r
866   <th>tests</th>\r
867   <td>Build all ICU4J unit test sub-components (under the directory <code>main/tests</code>)\r
868   and their dependencies.</td>\r
869 </tr>\r
870 <tr>\r
871   <th>tools</th>\r
872   <td>Build the tools.</td>\r
873 </tr>\r
874 <tr>\r
875   <th>docs</th>\r
876   <td>Run javadoc over the ICU4J runtime library files, generating an HTML documentation\r
877   tree in the subdirectory <code>doc</code>.</td>\r
878 </tr>\r
879 <tr>\r
880   <th>jarDocs</th>\r
881   <td>Create ICU4J doc jar archive (<code>icu4jdocs.jar</code>) containing API reference\r
882   docs in the root ICU4J directory. </td>\r
883 </tr>\r
884 <tr>\r
885   <th>jarDemos</th>\r
886   <td>Create ICU4J demo jar archive (<code>icu4jdemos.jar</code>) in the root ICU4J\r
887   directory.</td>\r
888 </tr>\r
889 </table>\r
890 \r
891 <p>For more information, read the Ant documentation and the <strong>build.xml</strong>\r
892 file.</p>\r
893 <b>Note:</b> If you get an OutOfMemoryError when you are running <tt>"ant check"</tt>,\r
894 you can set the heap size of the jvm by setting the environment variable JVM_OPTIONS\r
895 to the appropriate java options.</p>\r
896 \r
897 <p><b>Eclipse users:</b> See the ICU4J site for information on<a\r
898  href="http://www.icu-project.org/docs/eclipse_howto/eclipse_howto.html">\r
899 how to configure Eclipse</a> to build and develop ICU4J on Eclipse IDE.</p>\r
900 \r
901 <p><b>Note: </b>To install ICU4J Locale Service Provider, please refer\r
902 <a href="localespi/readme.html">Read Me for ICU4J Locale Service Provider</a>.</p>\r
903 \r
904 <h3 class="doc"><a name="HowToModularize"></a>How to modularize ICU4J</h3>\r
905 <p>Some clients may not wish to ship all of ICU4J with their\r
906 application, since the application might only use a small part of ICU4J.\r
907 ICU4J release 2.6 and later provide build options to build individual\r
908 ICU4J 'modules' for a more compact distribution.  For more details, please\r
909 refer to the section <em>Modularization of ICU4J</em> in the ICU user's\r
910 guide article <a href="http://userguide.icu-project.org/packaging-icu4j">Packaging ICU4J</a>.\r
911 \r
912 <h3 class="doc"><a name="tryingout"></a>Trying Out ICU4J</h3>\r
913 <p><strong>Note:</strong> the demos provided with ICU4J are for the\r
914 most part undocumented. This list can show you where to look, but\r
915 you'll have to experiment a bit. The demos are <strong>unsupported</strong>\r
916 and may change or disappear without notice.</p>\r
917 <p>The icu4j.jar file contains only the ICU4J runtime library classes, not the\r
918 demo classes, so unless you build ICU4J there is little to try out.\r
919 </p>\r
920 <h4>Charset</h4>\r
921 To try out the <strong>Charset</strong> package, build <strong>icu4j.jar</strong> and\r
922 <strong>icu4j-charsets.jar</strong> using the 'jar' target.\r
923 You can use the charsets by placing these files on your classpath.\r
924 <blockquote><tt>java -cp $icu4j_root/icu4j.jar:$icu4j_root/icu4j-charsets.jar &lt;your program&gt;</tt></blockquote>\r
925 <h4>Other demos</h4>\r
926 <p>The other demo programs are <strong>not supported</strong> and\r
927 exist only to let you experiment with the ICU4J classes. First, build ICU4J using <tt>ant&nbsp;jarDemos</tt>.\r
928 Then launch the demos as below:\r
929 <blockquote><tt>java -jar $icu4j_root/icu4jdemos.jar</tt></blockquote>\r
930 </p>\r
931 \r
932 <h3 class="doc"><a name="resources">ICU4J Resource Information</a></h3>\r
933 Starting with release 2.1, ICU4J includes its own\r
934 resource information\r
935 which is completely independent of the JRE resource information. (Note,\r
936 ICU4J 2.8 to 3.4, time zone information depends on the underlying JRE).\r
937 The ICU4J resource information is equivalent to the information in ICU4C and\r
938 many resources are, in fact, the same binary files that ICU4C uses.\r
939 <p>\r
940 By default the ICU4J distribution includes all of the standard resource\r
941 information. It is located under the directory com/ibm/icu/impl/data.\r
942 Depending on the service, the data is in different locations and in\r
943 different formats. <strong>Note:</strong> This will continue to change\r
944 from release to release, so clients should not depend on the exact\r
945 organization\r
946 of the data in ICU4J.</p>\r
947 <ul>\r
948   <li>The primary <b>locale data</b> is under the directory <tt>icudt44b</tt>,\r
949   as a set of <tt>".res"</tt> files whose names are the locale identifiers. \r
950   Locale naming is documented the <code>com.ibm.icu.util.ULocale</code>\r
951   class, and the use of these names in searching for resources is documented \r
952   in <code>com.ibm.icu.util.UResourceBundle</code>.</li>\r
953 \r
954   <li>The <b>collation data</b> is under the directory <tt>icudt44b/coll</tt>,\r
955   as a set of <tt>".res"</tt> files.</li>\r
956 \r
957   <li>The <b>currency display name data</b> is under the directory <tt>icudt44b/curr</tt>,\r
958   as a set of <tt>".res"</tt> files.</li>\r
959 \r
960   <li>The <b>language display name data</b> is under the directory <tt>icudt44b/lang</tt>,\r
961   as a set of <tt>".res"</tt> files.</li>\r
962 \r
963   <li>The <b>region display name data</b> is under the directory <tt>icudt44b/region</tt>,\r
964   as a set of <tt>".res"</tt> files.</li>\r
965 \r
966   <li>The <b>rule-based transliterator data</b> is under the directory\r
967   <tt>icudt44b/translit</tt>, as a set of <tt>".res"</tt> files.</li>\r
968 \r
969   <li>The <b>rule-based number format data</b> is under the directory\r
970   <tt>icudt44b/rbnf</tt>, as a set of <tt>".res"</tt> files.\r
971 \r
972   <li>The <b>break iterator data</b> is directly under the\r
973   directory <tt>icudt44b</tt>, as a set of <tt>".brk"</tt> files, named according to the\r
974   type of break and the locale where there are locale-specific versions.</li>\r
975 \r
976   <li>The <b>holiday data</b> is under the directory <tt>icudt44b</tt>,\r
977   as a set of <tt>".class"</tt> files, named <tt>"HolidayBundle_"</tt>\r
978   followed by the locale ID.</li>\r
979 \r
980   <li>The <b>character property data</b> as well as assorted <b>normalization\r
981   data</b> and default <b>unicode collation algorithm (UCA) data</b>\r
982   is found under the directory <tt>icudt44b</tt>, as a set of <tt>".icu"</tt>\r
983   files. </li>\r
984 \r
985   <li>The <b>character set converter data</b> is under the directory\r
986   <tt>icudt44b</tt>, as a set of <tt>".cnv"</tt> files.  These files are\r
987   currently included only in icu-charset.jar.</li>\r
988 \r
989   <li>The <b>time zone rule data</b> is under the directory \r
990   <tt>icudt44b</tt>, as <tt>zoneinfo64.res</tt>.</li>\r
991 \r
992   <li>The <b>time zone display name data</b> is under the directory\r
993   <tt>icudt44b/zone</tt>, as a set of <tt>".res"</tt> files.</li>\r
994 </ul>\r
995 <p>\r
996 Some of the data files alias or otherwise reference data from other\r
997 data files. One reason for this is because some locale names have\r
998 changed. For example, <tt>he_IL</tt> used to be <tt>iw_IL</tt>. In\r
999 order to support both names but not duplicate the data, one of the\r
1000 resource files refers to the other file's data. In other cases, a\r
1001 file may alias a portion of another file's data in order to save\r
1002 space. Currently ICU4J provides no tool for revealing these\r
1003 dependencies.</p>\r
1004 <blockquote><strong>Note:</strong>  Java's <code>Locale</code> class\r
1005 silently converts the language code <tt>"he"</tt> to <tt>"iw"</tt>\r
1006 when you construct the Locale (for versions of Java through Java 5). Thus\r
1007 Java cannot be used to locate resources that use the <tt>"he"</tt>\r
1008 language code. ICU, on the other hand, does not perform this\r
1009 conversion in ULocale, and instead uses aliasing in the locale data to\r
1010 represent the same set of data under different locale\r
1011 ids.</blockquote>\r
1012 <p>\r
1013 Resource files that use locale ids form a hierarchy, with up to four\r
1014 levels: a root, language, region (country), and variant. Searches for\r
1015 locale data attempt to match as far down the hierarchy as possible,\r
1016 for example, <tt>"he_IL"</tt> will match <tt>he_IL</tt>, but\r
1017 <tt>"he_US"</tt> will match <tt>he</tt> (since there is no <tt>US</tt>\r
1018 variant for he, and <tt>"xx_YY</tt> will match root (the\r
1019 default fallback locale) since there is no <tt>xx</tt> language code\r
1020 in the locale hierarchy. Again, see\r
1021 <code>java.util.ResourceBundle</code> for more information.\r
1022 </p>\r
1023 <p>\r
1024 <strong>Currently ICU4J provides no tool for revealing these\r
1025 dependencies</strong> between data files, so trimming the data\r
1026 directly in the ICU4J project is a hit-or-miss affair. The key point\r
1027 when you remove data is to make sure to remove all dependencies on\r
1028 that data as well. For example, if you remove <tt>he.res</tt>, you\r
1029 need to remove <tt>he_IL.res</tt>, since it is lower in the hierarchy,\r
1030 and you must remove iw.res, since it references <tt>he.res</tt>, and\r
1031 <tt>iw_IL.res</tt>, since it depends on it (and also references\r
1032 <tt>he_IL.res</tt>).\r
1033 </p>\r
1034 <p>\r
1035 Unfortunately, the jar tool in the JDK provides no way to remove items\r
1036 from a jar file. Thus you have to extract the resources, remove the\r
1037 ones you don't want, and then create a new jar file with the remining\r
1038 resources. See the jar tool information for how to do this. Before\r
1039 'rejaring' the files, be sure to thoroughly test your application with\r
1040 the remaining resources, making sure each required resource is\r
1041 present.\r
1042 </p>\r
1043 <h4>Using additional resource files with ICU4J</h4>\r
1044 <blockquote>\r
1045   <table cellpadding="3" frame="border" rules="none" width="50%">\r
1046     <tbody>\r
1047       <tr>\r
1048         <td><b><font color="red" size="+1">Warning:</font> Resource\r
1049 file formats can change across releases of ICU4J!</b></td>\r
1050       </tr>\r
1051       <tr>\r
1052         <td>The format of ICU4J resources is not part of the API.\r
1053 Clients who develop their own resources for use with ICU4J should be\r
1054 prepared to\r
1055 regenerate them when they move to new releases of ICU4J.</td>\r
1056       </tr>\r
1057     </tbody>\r
1058   </table>\r
1059 </blockquote>\r
1060 <p>\r
1061 We are still developing ICU4J's resource mechanism. Currently it \r
1062 is not possible to mix icu's new binary <tt>.res</tt>\r
1063 resources\r
1064 with traditional java-style <tt>.class</tt> or <tt>.txt</tt>\r
1065 resources. We might\r
1066 allow for this in a future release, but since the resource data and\r
1067 format is not formally\r
1068 supported, you run the risk of incompatibilities with future releases\r
1069 of ICU4J.\r
1070 </p>\r
1071 <p>\r
1072 Resource data in ICU4J is checked in to the repository as a jar file\r
1073 containing the resource binaries, <tt>icudata.jar</tt>. This\r
1074 means that inspecting the contents of these resources is difficult.\r
1075 They currently are compiled from ICU4C <tt>.txt</tt> file data. You\r
1076 can view the contents of the ICU4C text resource files to understand\r
1077 the contents of the ICU4J resources.\r
1078 </p>\r
1079 <p>\r
1080 The files in <tt>icudata.jar</tt> get extracted to <tt>com/ibm/icu/impl/data</tt>\r
1081 in\r
1082 the build directory when the 'core' target is built.\r
1083 Building the <tt>'resources'</tt> target will force the\r
1084 resources to once again be extracted. Extraction will\r
1085 overwrite any corresponding resource files already in that directory.\r
1086 </p>\r
1087 <h4><a name="resourcesICU4C">Building ICU4J Resources from ICU4C</a></h4>\r
1088 ICU4J data is built by ICU4C tools. Please see "icu4j-readme.txt" in <I>$icu4c_root</I>/source/data for the procedures.\r
1089 <h5> Generating Data from CLDR </h5>\r
1090 <I> Note: This procedure assumes that all 3 sources are in sibling directories</I>\r
1091 <ol>\r
1092     <li>Checkout CLDR.  $cldr_root in the following steps is the root directory where\r
1093     the CLDR source files checked out.</li>\r
1094     <li>Update <I>$cldr_root</I>/common to 'release-1-8-1' tag</li>\r
1095     <li>Update <I>$cldr_root</I>/tools to 'release-1-8-1' tag</li>\r
1096     <li>Checkout ICU4C with tag 'release-4-4-1'</li>\r
1097     <li>Checkout ICU4J with tag 'release-4-4-1'</li>\r
1098     <li>Build ICU4J</li>\r
1099     <li>Build ICU4C</li>\r
1100     <li>Change to <I>$cldr_root</I>/tools/java directory</li>\r
1101     <li>Build CLDR using ant after pointing ICU4J_CLASSES env var to the newly build ICU4J</li>\r
1102     <li>cd to <I>$icu4c_root</I>/source/data directory</li>\r
1103     <li>Follow the instructions in the cldr-icu-readme.txt</li>\r
1104     <li>Build ICU4C data from CLDR</li>\r
1105     <li>Build ICU4J data from ICU4C data by following the procedures in <I>$icu4c_root</I>/source/data/icu4j-readme.txt</li>\r
1106     <li>cd to <I>$icu4j_root</I> dir</li>\r
1107     <li>Build and test icu4j</li>\r
1108 </ol>\r
1109 \r
1110 <h3 class="doc"><a name="timezone"></a>About ICU4J Time Zone</h3>\r
1111 <p>ICU4J 4.4.2 includes time zone data version 2010m, which is the latest one as of\r
1112 the release date.  However, time zone data is frequently updated in response\r
1113 to changes made by local governments around the world.  If you need to update\r
1114 the time zone data, please refer the ICU user guide topic\r
1115 <a href="http://www.icu-project.org/userguide/dateTimezone.html#tzupdate">Updating the Time Zone Data</a>.</p>\r
1116 <p>Starting with ICU4J 4.0, you can optionally configure ICU4J date and time\r
1117 service classes to use underlying JDK TimeZone implementation (see the ICU4J API reference\r
1118 <a href="http://www.icu-project.org/apiref/icu4j/com/ibm/icu/util/TimeZone.html">TimeZone</a>\r
1119 for the details).  When this configuration is enabled, ICU's own time zone data\r
1120 won't be used and you have to get time zone data patches from the JRE vendor.</p>\r
1121 \r
1122 <h3 class="doc"><a name="WhereToFindMore"></a>Where to Find More\r
1123 Information</h3>\r
1124 <p><a href="http://www.icu-project.org/">http://www.icu-project.org/</a>\r
1125 is the home page of International Components for Unicode development project</p>\r
1126 <p><a href="http://www.ibm.com/software/globalization/icu/">http://www.ibm.com/software/globalization/icu/</a>\r
1127 is a pointer to general information about the International Components for\r
1128 Unicode hosted by IBM</p>\r
1129 <p><a href="http://www.ibm.com/software/globalization/">http://www.ibm.com/software/globalization/</a>\r
1130 is a pointer to\r
1131 information on how to make applications global. </p>\r
1132 <h3 class="doc"><a name="SubmittingComments"></a>Submitting Comments,\r
1133 Requesting Features and\r
1134 Reporting Bugs</h3>\r
1135 <p>Your comments are important to making ICU4J successful. We are\r
1136 committed to investigate any bug reports or suggestions,\r
1137 and will use your feedback to help plan future releases.</p>\r
1138 <p>To submit comments, request features and report bugs,\r
1139 please see <a href="http://www.icu-project.org/bugs.html">ICU bug database\r
1140 information</a> or contact us through the <a\r
1141  href="http://www.icu-project.org/contacts.html">ICU Support\r
1142 mailing list</a>.  While we are not able to respond individually to each comment, we do\r
1143 review all comments.</p>\r
1144 <br>\r
1145 <br>\r
1146 <h2>Thank you for your interest in ICU4J!</h2>\r
1147 <br>\r
1148 <hr align="center" size="2" width="100%">\r
1149 <p><I><font size="-1">Copyright &copy; 2002-2010 International Business\r
1150 Machines Corporation and others. All Rights\r
1151 Reserved.<br>\r
1152 4400 North First Street, San Jos&eacute;, CA 95193, USA\r
1153 </font></I></p>\r
1154 </body>\r
1155 </html>\r