For details on how to load the project into Eclipse and/or recompile the sources and the Javadoc, read below.
The instructions assume you have installed any needed tools, such as Eclipse, Ant or the JDK. Only JDK is required. Either Eclipse or Ant (or both) is highly recommended. However, it is possible to get by without Ant and Eclipse if you want to do all the setup and compilation yourself.
Ant details and installation instructions can be found at the Apache Ant Project. The build scripts were developed with Ant 1.6.5.
Eclipse details and installation instructions can be found at the Eclipse web site. Eclipse 3.1.x was used for development of the WVCM reference implementation and the TCK.
The specification has been developed with Sun's Java 1.4.2 JDK.
Once imported, the Java source should automatically compile without error. The result of the compilation will be Java class files in a "bin" directory beside the "src" directory.
The Ant script is capable of the following:
Select the "jsr147" project's "build.xml" file within the Project Explorer view. Select menu item "Run->External Tools->Run As->Ant Build".
When you run this script, it'll run the default "jar" target, resulting in a "wvcm.jar" file at "dist/lib/wvcm.jar". To make it do something else such as generate Javadoc, edit the configuration and specify "doc" for its target. Or, specify "all" to make it do everything.
To use Ant, you will of course need Ant. If you already have Eclipse
installed, then you probably already have Ant; it is included as an Eclipse
plugin and is typically at C:\eclipse\plugins\org.apache.ant_1.6.5
.
Briefly, you can set up a script on Windows to use Ant like this:
set ANT_HOME=C:\apache-ant-1.6.5 set JAVA_HOME=C:\java142 set path=%ANT_HOME%\bin;%JAVA_HOME%\bin;%path%
And on Unix within the CSH or TCSH shells, like this:
setenv ANT_HOME ~/apache-ant-1.6.5 setenv JAVA_HOME ~/jdk142 setenv PATH $ANT_HOME/bin:$JAVA_HOME/bin:$PATH
Modify the paths appropriately to point to where you have installed Ant and the Java JDK.
Once you have Ant configured properly, change directory to the "jsr147" project. Then, type "ant -p" to see what choices you have available. The default target just compiles the source and creates jar files. You may also choose to generate Javadoc. The "all" target builds everything.
This will require implementing the WVCM interfaces, so these interfaces will need to be in your classpath. The interfaces are located in the wvcm.jar file that this project builds. If you are developing your implementation within Eclipse, you can have the Eclipse build path preferences for a project point to this wvcm.jar file. If building from Ant, do whatever is necessary within your implementation's build.xml file to add wvcm.jar to the classpath of any Ant task that makes use of a classpath.
You may also examine, run and test the WVCM Reference Implemenation (RI) to learn more about the functionality that is expected by the WVCM specification. The RI is the separately distributed "jsr147_ri" project. The TCK can also be used to test the RI (and does so by default). And, the source code for the TCK's unit tests can also be useful in understanding how a WVCM implementation is supposed to function.