International Components for Unicode for Java (ICU4J)

Read Me for ICU4J 3.8d01

Release Date
August 3, 2007

Note: This is major release of ICU4J. It contains bug fixes and adds implementations of inherited API and introduces new API or functionality.

For the most recent release, see the ICU4J download site.

Contents

• Introduction to ICU4J
• What Is New In This Release?
• License Information
• Platform Dependencies
• How to Download ICU4J
• The Structure and Contents of ICU4J
• Where to Get Documentation
• How to Install and Build
• How to modularize ICU4J
• Trying Out ICU4J
• ICU4J Resource Information
• Where to Find More Information
• Submitting Comments, Requesting Features and Reporting Bugs

Introduction to ICU4J

The International Components for Unicode (ICU) library provides robust and full-featured Unicode services on a wide variety of platforms. ICU supports the most current version of the Unicode standard, including support for supplementary characters (needed for GB 18030 repertoire support).

Java provides a strong foundation for global programs, and IBM and the ICU team played a key role in providing globalization technology to Java. But because of its long release schedule, Java cannot always keep up with evolving standards. The ICU team continues to extend Java's Unicode and internationalization support, focusing on improving performance, keeping current with the Unicode standard, and providing richer APIs, while remaining as compatible as possible with the original Java text and internationalization API design.

ICU4J is an add-on to the regular JVM that provides:

• Collation – rule-based, up-to-date Unicode Collation Algorithm (UCA) sorting order
      For fast multilingual string comparison; faster and more complete than the JDK
• Supplementary Characters – String manipulation and character properties
      Required for proper GB 18030 and JIS 213 repertoire support
• Charset Detection – Recognition of various single and multibyte charsets
      Useful for recognizing untagged text data
• UnicodeSet – standard set operations optimized for sets of Unicode characters
      UnicodeSets can be built from string patterns using any Unicode properties.
• Transforms – a flexible mechanism for Unicode text conversions
      Including Full/Halfwidth conversions, Normalization, Case conversions, Hex conversions, and transliterations between scripts (50+ pairs)
• Unicode Normalization – NFC, NFD, NFKD, NFKC
      For canonical text representations, needed for XML and the net
• International Calendars – Arabic, Buddhist, Chinese, Hebrew, Japanese, Ethiopic, Islamic, Coptic and other calendars
      Required for correct presentation of dates in certain countries
• Number Format Enhancements – Scientific Notation, Spelled-out, etc.
      Enhancements to the normal Java number formatting. The spell-out format is used for checks and similar documents
• Enhanced Word-Break Detection – Rule-based, supports Thai
      Required for correct support of Thai
• Unicode Text Compression – Standard compression of Unicode text
      Suitable for large numbers of small fields, where LZW and similar schemes do not apply
• Charset Conversion – Conversion to and from different charsets.
      Plugs into JDK's CharsetProvider Service Provider Interface (SPI)

Note: We continue to provide assistance to Sun, and in some cases, ICU4J support has been rolled into a later release of Java. For example, the Thai word-break is now in Java 1.4. However, the most current and complete version is always found in ICU4J.

What Is New In This Release?

See the ICU 3.8 download page about new features in this release.

License Information

The ICU projects (ICU4C and ICU4J) use the X license. The X license is suitable for commercial use and is a recommended free software license that is compatible with the GNU GPL license. This became effective with release 1.8.1 of ICU4C and release 1.3.1 of ICU4J in mid-2001. All new ICU releases will adopt the X license; previous ICU releases continue to utilize the IPL (IBM Public License). Users of previous releases of ICU who want to adopt new ICU releases will need to accept the terms and conditions of the X license.

The main effect of the change is to provide GPL compatibility. The X license is listed as GPL compatible, see the GNU page at http://www.gnu.org/philosophy/license-list.html#GPLCompatibleLicenses. This means that GPL projects can now use ICU code, it does not mean that projects using ICU become subject to GPL.

The IBM version contains the essential text of the license, omitting the X-specific trademarks and copyright notices. The full copy of ICU's license is included in the download package.

Platform Dependencies

By default ICU4J depends on functionality that is only available in JDK 1.4 or later releases. We provide the ability to build a variant of ICU4J that will run on JDK 1.3, but not all build targets work on that platform. Currently 1.1.x and 1.2.x JVMs are unsupported and untested, and you use the components on these JVMs at your own risk.

The reference platforms which we support and test ICU4J on are:

• WinXP, IBM JDK 1.5.0
• Solaris 5.10, Sun JDK 1.5.0
• AIX 5.3, IBM JDK 1.5.0

Please use the most recent updates of the supported JDK versions.

Additionally, we have built and tested ICU4J on the following unsupported platforms (note, only some build/test targets work on 1.3 platforms):

• Windows XP / IBM JDK 1.4.2, Sun JDK 1.5.0, 1.4.2
• Windows Vista / IBM JDK 1.5.0, 1.4.2, Sun JDK 1.6.0, 1.5.0, 1.4.2
• Solaris 5.9 / Sun JDK 1.6.0, 1.5.0, 1.4.2
• Solaris 5.10 / Sun JDK 1.6.0, 1.4.2
• AIX 5.2 / IBM JDK 1.5.0, 1.4.2
• AIX 5.3 / IBM JDK 1.4.2
• RedHat Enterprise Linux 3/ IBM JDK 1.5.0, 1.4.2, Sun JDK 1.6.0, 1.5.0, 1.4.2
• HP UX Sun JDK 1.5.0, 1.4.2

How to Download ICU4J

There are two ways to download the ICU4J releases.

• Official Release Snapshot:
  If you want to use ICU4J (as opposed to developing it), your best bet is to download an official, packaged version of the ICU4J source code. These versions are tested more thoroughly than day-to-day development builds, and they are packaged in jar files for convenient download. These packaged files can be found at the ICU Downloads page. A packaged snapshot is named icu4j-XXX-src.jar, where XXX is the release version number. Please unjar this file. It will reconstruct the source directory.

• Subversion Source Repository:
  If you are interested in developing features, patches, or bug fixes for ICU4J, you should probably be working with the latest version of the ICU4J source code. You will need to check the code out of our Subversion repository to ensure that you have the most recent version of all of the files. There are several ways to do this. Please follow the directions that are contained on the Source Repository page for details.

For more details on how to download ICU4J directly from the web site, please see the ICU downloads page at http://www.icu-project.org/download/

The Structure and Contents of ICU4J

Below, $Root is the placement of the icu directory in your file system, like "drive:\...\icu4j" in your environment. "drive:\..." stands for any drive and any directory on that drive that you chose to install icu4j into.

Information and build files:

The source directories mirror the package structure of the code.
Core packages become part of the ICU4J jar file.
Charset packages become part of the ICU4J charset jar file.
API packages contain classes with supported API.
RichText classes are Core and API, but can be removed from icu4j.jar, and can be built into their own jar.

Building ICU4J creates and populates the following directories:

ICU4J data is stored in the following locations:

Where to get Documentation

The ICU user's guide contains lots of general information about ICU, in its C, C++, and Java incarnations.

The complete API documentation for ICU4J (javadoc) is available on the ICU4J web site, and can be built from the sources:

• Index to all ICU4J API
• Charset Detector – Detection of charset from a byte stream
• International Calendars – Buddhist, Chinese, Coptic, Ethiopic, Gregorian, Hebrew, Islamic, Japanese.
• Unicode Normalization – Canonical text representation for W3C.
• Number Format Enhancements – Scientific Notation, Spelled out.
• Enhanced word-break detection – Rule-based, supports Thai
• Transliteration – A general framework for onverting text from one format to another, e.g. Cyrillic to Latin, or Hex to Unicode.
• Unicode Text Compression & Decompression – 2:1 compression on English Unicode text.
• Collation - Rule-based sorting, Efficient multi-lingual searching

How to Install and Build

To install ICU4J, simply place the prebuilt jar file icu4j.jar on your Java CLASSPATH. If you need Charset API support please place icu4j-charsets.jar on your class path. No other files are needed.

Eclipse users: See the ICU4J site for information on how to configure Eclipse to build ICU4J.

To build ICU4J, you will need a Java2 JDK and the Ant build system. We strongly recommend using the Ant build system to build ICU4J. It's recommended to install both the JDK and Ant somewhere outside the ICU4J directory. For example, on Linux you might install these in /usr/local.

• Install a recent JDK, version 1.4.x or later will work.
• Install the Ant build system. Ant is a portable, Java-based build system similar to make. ICU4J uses Ant because it introduces no other dependencies, it's portable, and it's easier to manage than a collection of makefiles. We currently build ICU4J using a single makefile on both Windows 9x and Linux using Ant. The build system requires Ant 1.6 or later.

  Installing Ant is straightforward. Download it (see http://ant.apache.org/bindownload.cgi), extract it onto your system, set some environment variables, and add its bin directory to your path. For example:

      set JAVA_HOME=C:\jdk1.5.0
      set ANT_HOME=C:\ant
      set PATH=%PATH%;%ANT_HOME%\bin

  See the current Ant documentation for details.

Once the JDK and Ant are installed, building is just a matter of typing ant in the ICU4J root directory. This causes the Ant build system to perform a build as specified by the file build.xml, located in the ICU4J root directory. You can give Ant options like -verbose, and you can specify targets. Ant will only build what's been changed and will resolve dependencies properly. For example:

F:\icu4j>ant tests
Buildfile: build.xml
Project base dir set to: F:\icu4j
Executing Target: core
Compiling 71 source files to F:\icu4j\classes
Executing Target: tests
Compiling 24 source files to F:\icu4j\classes
Completed in 19 seconds

The following are some targets that you can provide to ant. For more targets run ant -projecthelp or see the build.xml file.

For more information, read the Ant documentation and the build.xml file.

After doing a build it is a good idea to run all the icu4j tests by typing
"ant check" or "java -classpath $Root/classes com.ibm.icu.dev.test.TestAll -nothrow".

(If you are allergic to build systems, as an alternative to using Ant you can build by running javac and javadoc directly. This is not recommended. You may have to manually create destination directories.)

How to modularize ICU4J

Some clients may not wish to ship all of ICU4J with their application, since the application might only use a small part of ICU4J. ICU4J release 2.6 and later provide build options to build individual ICU4J 'modules' for a more compact distribution. The modules are based on a service and the APIs that define it, e.g., the normalizer module supports all the APIs of the Normalizer class (and some others). Tests can be run to verify that the APIs supported by the module function correctly. Because of internal code dependencies, a module contains extra classes that are not part of the module's core service API. Some or most of the APIs of these extra classes will not work. Only the module's core service API is guaranteed. Other APIs may work partially or not at all, so client code should avoid them.

Individual modules are not built directly into their own separate jar files. Since their dependencies often overlap, using separate modules to 'add on' ICU4J functionality would result in unwanted duplication of class files. Instead, building a module causes a subset of ICU4J's classes to be built and put into ICU4J's standard build directory. After one or more module targets are built, the 'moduleJar' target can then be built, which packages the class files into a 'module jar.' Other than the fact that it contains fewer class files, little distinguishes this jar file from a full ICU4J jar file, and in fact they share the same name.

Currently ICU4J can be divided into the following modules:

Key:

Modules:

Building any of these modules is as easy as specifying a build target to the Ant build system, e.g:
To build a module that contains only the Normalizer API:

1. Build the module.
   ant normalizer
2. Build the jar containing the module.
   ant moduleJar
3. Build the tests for the module.
   ant normalizerTests
4. Run the tests and verify that the self tests pass.
   java -classpath $icu4j_root/classes com.ibm.icu.dev.test.TestAll -nothrow -w

1. Build the modules.
   ant normalizer collator
2. Build the jar containing the modules.
   ant moduleJar
3. Build the tests for the module.
   ant normalizerTests collatorTests
4. Run the tests and verify that they pass.
   java -classpath $icu4j_root/classes com.ibm.icu.dev.test.TestAll -nothrow -w

Notes:

• Regardless of whether ICU4J is built as a whole or as modules, the jar file produced is named icu4j.jar.
• To ascertain if an icu4j.jar contains all of ICU4J or not, please see the manifest file in the jar
• The target moduleJar does not depend on any other target. It just creates a jar of all class files under $icu4j_root/classes/com/ibm/icu/, excluding the classs files in $icu4j_root/classes/com/ibm/icu/dev folder
• The list of module build targets can be obtained by running the command: ant -projecthelp

Trying Out ICU4J

Note: the demos provided with ICU4J are for the most part undocumented. This list can show you where to look, but you'll have to experiment a bit. The demos (with the exception of richedit) are unsupported and may change or disappear without notice.

The icu4j.jar file contains only the core ICU4J classes, not the demo classes, so unless you build ICU4J there is little to try out.

Charset

java -cp $Root/icu4j.jar:$Root/icu4j-charsets.jar <your program>

Rich Edit

java -jar $Root/richedit/richedit.jar

With a fuller command line you can try out other options, for example:

java -classpath $Root/richedit/richedit.jar com.ibm.richtext.demo.EditDemo [-swing][file]

This will use an awt GUI, or a swing GUI if -swing is passed on the command line. It will open a text file if one is provided, otherwise it will open a blank page. Click to type.

You can add tabs to the tab ruler by clicking in the ruler while holding down the control key. Clicking on an existing tab changes between left, right, center, and decimal tabs. Dragging a tab moves it, dragging it off the ruler removes it.

You can experiment with complex text by using the keymap functions. Please note that these are mainly for demo purposes, for real work with Arabic or Hebrew you will want to use an input method. You will need to use a font that supports Arabic or Hebrew, 'Lucida Sans' (provided with Java) supports these languages.

Other demos

The other demo programs are not supported and exist only to let you experiment with the ICU4J classes. First, build ICU4J using ant all. Then try one of the following:

• java -classpath classes com.ibm.icu.dev.demo.calendar.CalendarApp
• java -classpath classes com.ibm.icu.dev.demo.holiday.HolidayCalendarDemo
• java -classpath classes com.ibm.icu.dev.demo.rbbi.TextBoundDemo
  (Click in the text, then use ctrl-N and ctrl-P to select the next or previous block of text.)
• java -classpath classes com.ibm.icu.dev.demo.rbnf.RbnfDemo
• java -classpath classes com.ibm.icu.dev.demo.translit.Demo

ICU4J Resource Information

By default the ICU4J distribution includes all of the standard resource information. It is located under the directory com/ibm/icu/impl/data. Depending on the service, the data is in different locations and in different formats. Note: This will continue to change from release to release, so clients should not depend on the exact organization of the data in ICU4J.

• The primary locale data is under the directory icudt38b, as a set of ".res" files whose names are the locale identifiers. Locale naming is documented the com.ibm.icu.util.ULocale class, and the use of these names in searching for resources is documented in java.util.ResourceBundle.
• The collation data is under the directory icudt38b/coll, as a set of ".res" files.
• The rule-based transliterator data is under the directory icudt38b/translit as a set of ".res" files. (Note: the Han transliterator test data is no longer included in the core icu4j.jar file by default.)
• The rule-based number format data is under the directory icudt38b/rbnf as a set of ".res" files.
• The break iterator data is directly under the data directory, as a set of ".brk" files, named according to the type of break and the locale where there are locale-specific versions.
• The holiday data is under the data directory, as a set of ".class" files, named "HolidayBundle_" followed by the locale ID.
• The character property data as well as assorted normalization data and default unicode collation algorithm (UCA) data is found under the data directory as a set of ".icu" files.

Some of the data files alias or otherwise reference data from other data files. One reason for this is because some locale names have changed. For example, he_IL used to be iw_IL. In order to support both names but not duplicate the data, one of the resource files refers to the other file's data. In other cases, a file may alias a portion of another file's data in order to save space. Currently ICU4J provides no tool for revealing these dependencies.

Note: Java's Locale class silently converts the language code "he" to "iw" when you construct the Locale (for versions of Java through Java 5). Thus Java cannot be used to locate resources that use the "he" language code. ICU, on the other hand, does not perform this conversion in ULocale, and instead uses aliasing in the locale data to represent the same set of data under different locale ids.

Resource files that use locale ids form a hierarchy, with up to four levels: a root, language, region (country), and variant. Searches for locale data attempt to match as far down the hierarchy as possible, for example, "he_IL" will match he_IL, but "he_US" will match he (since there is no US variant for he, and "xx_YY will match root (the default fallback locale) since there is no xx language code in the locale hierarchy. Again, see java.util.ResourceBundle for more information.

Currently ICU4J provides no tool for revealing these dependencies between data files, so trimming the data directly in the ICU4J project is a hit-or-miss affair. The key point when you remove data is to make sure to remove all dependencies on that data as well. For example, if you remove he.res, you need to remove he_IL.res, since it is lower in the hierarchy, and you must remove iw.res, since it references he.res, and iw_IL.res, since it depends on it (and also references he_IL.res).

Unfortunately, the jar tool in the JDK provides no way to remove items from a jar file. Thus you have to extract the resources, remove the ones you don't want, and then create a new jar file with the remining resources. See the jar tool information for how to do this. Before 'rejaring' the files, be sure to thoroughly test your application with the remaining resources, making sure each required resource is present.

Using additional resource files with ICU4J

Warning: Resource file formats can change across releases of ICU4J!

The format of ICU4J resources is not part of the API. Clients who develop their own resources for use with ICU4J should be prepared to regenerate them when they move to new releases of ICU4J.

We are still developing ICU4J's resource mechanism. Currently it is not possible to mix icu's new binary .res resources with traditional java-style .class or .txt resources. We might allow for this in a future release, but since the resource data and format is not formally supported, you run the risk of incompatibilities with future releases of ICU4J.

Resource data in ICU4J is checked in to the repository as a jar file containing the resource binaries, icudata.jar. This means that inspecting the contents of these resources is difficult. They currently are compiled from ICU4C .txt file data. You can view the contents of the ICU4C text resource files to understand the contents of the ICU4J resources.

The files in icudata.jar get extracted to com/ibm/icu/impl/data in the build directory when the 'core' target is built. Building the 'resources' target will force the resources to once again be extracted. Extraction will overwrite any corresponding resource files already in that directory.

Building ICU4J Resources from ICU4C

Requirements

• ICU4C
• Compilers and tools required for building ICU4C.
• Java SDK version 1.4.0 or above.
• Perl version 5 or above.

Procedure

1. Download and build ICU4C on a Windows machine. For instructions on downloading and building ICU4C, please click here.
2. Change directory to $icu_root/source/tools/genrb
3. Launch gendtjar.pl from that directory itself with the command
   gendtjar.pl --icu-root=$icu_root --jar=$jdk_home/bin --icu4j-root=$icu4j_root --version=$icu_version
   e.g: gendtjar.pl --icu-root=\work\icu --jar=\jdk1.4.1\bin --icu4j-root=\work\icu4j --version=3.0
   Execution of gendtjar.pl script will create the required jar files in the $icu_root\source\tools\genrb\temp directory.
4. Move icudata.jar to $icu4j_root/src/com/ibm/icu/impl/data directory.
5. Move testdata.jar to $icu4j_root/src/com/ibm/dev/data directory.
6. Build resources target of ant to unpack the jar files with the following command.
   $ant_home/bin/ant resources

Generating Data from CLDR

1. Checkout CLDR
2. Update $cldr_root/common to 'release-1-4' tag
3. Update $cldr_root/tools to 'release-1-4' tag
4. Checkout ICU with tag 'release-3-6'
5. Checkout ICU4J with tag 'release-3-6'
6. Build ICU4J
7. Build ICU4C
8. Change to $cldr_root/tools/java directory
9. Build CLDR using ant after pointing ICU4J_CLASSES env var to the newly build ICU4J
10. cd to $icu4c_root/source/data directory
11. Follow the instructions in the cldr-icu-readme.txt
12. Build ICU data from CLDR
13. cd to $icu4c_root/source/tools/genrb
14. run ./gendtjar.pl
15. cd to $icu4j_root dir
16. Build and test icu4j

Where to Find More Information

http://www.ibm.com/software/globalization/icu/ is a pointer to general information about the International Components for Unicode in Java

http://www.ibm.com/software/globalization/ is a pointer to information on how to make applications global.

Submitting Comments, Requesting Features and Reporting Bugs

Your comments are important to making ICU4J successful. We are committed to fixing any bugs, and will use your feedback to help plan future releases.

To submit comments, request features and report bugs, contact us through the ICU Support mailing list.
While we are not able to respond individually to each comment, we do review all comments.

Thank you for your interest in ICU4J!

Copyright © 2002-2006 International Business Machines Corporation and others. All Rights Reserved.
4400 North First Street, San José, CA 95193, USA