mparker | 8bdb122 | 2009-05-27 22:16:16 +0000 | [diff] [blame^] | 1 | Jakarta Commons Collections |
| 2 | =========================== |
| 3 | |
| 4 | Welcome to the Collections component of the Jakarta Commons project. |
| 5 | This component contains many new collections and collection utilities. |
| 6 | |
| 7 | Two jar files are produced by this component. |
| 8 | The first, commons-collections.jar is the main jar used by applications. |
| 9 | The second, commons-collections-testframework.jar is an extension to junit |
| 10 | for testing new collection implementations and is not normally used by applications. |
| 11 | |
| 12 | |
| 13 | Building from source |
| 14 | -------------------- |
| 15 | This component requires the excellent Ant utility. |
| 16 | It can be found here : |
| 17 | |
| 18 | http://ant.apache.org/ |
| 19 | |
| 20 | For testing the project, you will also need JUnit : |
| 21 | |
| 22 | http://www.junit.org/ |
| 23 | |
| 24 | To let the test process find JUnit, you may make a |
| 25 | copy of the build.properties.sample file, rename to |
| 26 | build.properties, and modify to reflect |
| 27 | the location of the junit.jar on your computer. |
| 28 | |
| 29 | |
| 30 | Once you have Ant properly installed, and the |
| 31 | build.properties file correctly reflects the location |
| 32 | of your junit.jar, you are ready to build and test. |
| 33 | The major targets are: |
| 34 | |
| 35 | ant compile - compile the code |
| 36 | ant test - test using junit |
| 37 | ant jar - create a jar file |
| 38 | ant javadoc - build the javadoc |
| 39 | ant dist - create folders as per a distribution |
| 40 | ant tf.jar - create the testframework jar file |
| 41 | ant tf.javadoc - build the testframework javadoc |
| 42 | |
| 43 | |
| 44 | Maven |
| 45 | ----- |
| 46 | The component can also be built using Maven. (Ant is the primary build tool.) |
| 47 | It can be found here : |
| 48 | |
| 49 | http://maven.apache.org/ |
| 50 | |
| 51 | Once installed, the jars may be built with 'maven jar'. |