Version: 1.2 Dec 26 2000
COPYRIGHT:
Copyright (c) 2000 International Business Machines Corporation and others. All Rights
Reserved.
Today's software market is a global one in which it is desirable to develop and maintain one application that supports a wide variety of national languages. International Components for Unicode for Java provides the following tools to help you write language independent applications:
Your comments are important to making this release successful. We are committed to fixing any bugs, and will also use your feedback to help plan future releases.
IMPORTANT: Please make sure you understand the Copyright and License information.
There are two ways to download the ICU4J releases,
export CVSROOT=:pserver:anoncvs@oss.software.ibm.com:/usr/cvs/icu4j
cvs login CVS password: anoncvs
cvs checkout icu4j
cvs logoutFor more details on how to download ICU4J directly from the web site, please also see http:/oss.software.ibm.com/developerworks/opensource/icu4j/download/index.html
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.
The following files describe the code drop:
| readme.html (this file) | describes the International Components for Unicode for Java |
| license.html | contains IBM's public license |
The source directories mirror package structure of the code. The following directories contain source code and data files:
| $Root/src/data/ | Various data files used to generate ICU4J classes. Most of the files contain Unicode information that is available from http://www.unicode.org/. Used only by tools in the src/com/ibm/tools. |
| $Root/src/com/ibm/demo | Demonstration applications and Applets. |
| $Root/src/com/ibm/test | Tests for various ICU4J components.. For information about running the tests, see $Root/doc/com/ibm/test/TestAll.html. |
| $Root/src/com/ibm/tools | Various tools used to generate ICU4J classes. |
| $Root/src/com/ibm/text | The following components:
|
| $Root/src/com/ibm/util | Calendars and Holidays |
| $Root/build | Additional classes needed to build using Ant |
The following directories are populated when you've built everything:
| $Root/classes/ | contains all class files |
| $Root/docs | contains JavaDoc for all packages |
Data organization:
Data is stored in various locations in ICU4J:
com.ibm.util.resources or com.ibm.text.resources,
depending on whether the associated code lives in com.ibm.util or com.ibm.text.The complete API documentation is available on the ICU4J web site:
Parts of ICU4J depend on functionality that is only available in Java2 (JDk1.2) or later, although some components work under 1.1. However, all components should be compiled using a Java2 compiler as even components that run using a 1.1.x JVM may require language features that are only present in 1.2. Currently 1.1.x is unsupported and untested and you use the components on a 1.1.x system at your own risk.
To install ICU4J, simply place the prebuilt jar file icu4j.jar on your Java CLASSPATH. No other files are needed.
The prerequisites for building ICU4J are a working JDK and the Ant build system:
set JAVA_HOME=C:\jdk1.2.2
set ANT_HOME=C:\jakarta-ant
set PATH=%PATH%;%ANT_HOME%\bin
call antsetup
See the current Ant documentation for details.
Once Ant is 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.
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
Current targets that you can give after ant:
| all | Build all targets. |
| core | Build the main class files in the subdirectory classes. If no target is specified, core is assumed. |
| tests | Build the test class files. |
| demos | Build the demos. |
| tools | Build the tools. |
| docs | Run javadoc over the main class files, generating an HTML documentation tree in the subdirectory docs. |
| jar | Create a jar archive icu4j.jar in the root ICU4J directory containing the main class files. |
| zip | Create a zip archive of the source, docs, and jar file for distribution, excluding unwanted things like CVS directories and emacs backup files. The zip file icu4jYYYYMMDD.zip will be created in the directory above the root ICU4J directory, where YYYYMMDD is today's date. Any existing file of that name will be overwritten. |
| zipsrc | Like the zip target, without the docs and the jar file. The zip file icu4jsrcYYYYMMDD.zip will be created in the directory above the root ICU4J directory. |
| clean | Remove all built targets, leaving the source. |
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 tests by typeing "java -classpath classes com.ibm.test.TestAll".
(As an alternative to using Ant, you can build simply by running javac and javadoc directly. This is not recommended, but a Windows batch file "buildall.bat" exists to get you started if you're really allergic to build systems. You may have to create destination directories.)
http://oss.software.ibm.com/icu4j is a pointer to general information about the International Components for Unicode in Java
http://www.ibm.com/developer/unicode is a pointer to information on how to make applications global.
To submit comments, request features and report bugs, contact us through the ICU4J mailing list.
While we are not able to respond individually to each comment, we do review all comments.
Copyright © 2000 International Business Machines Corporation and others. All Rights
Reserved.
IBM Center for Java Technology Silicon Valley,
10275 N De Anza Blvd., Cupertino, CA 95014
All rights reserved.