wamblee.org Git - utils/blob - support/general/src/site/xdoc/index.xml

   1 <?xml version="1.0"?>
   2 <document xmlns="http://maven.apache.org/XDOC/2.0"
   3   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   4   xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
   5
   6   <properties>
   7     <title>user guide</title>
   8     <author email="erik@brakkee.org">Erik Brakkee</author>
   9   </properties>
  10   <body>
  11     <section name="Overview">
  12       <p>The general support library contains various smaller utilities that can be useful for any
  13         java project. Utilities are available in the following areas:</p>
  14       <ul>
  15         <li><a href="apidocs/org/wamblee/cache/package-summary.html">Caching</a></li>
  16         <li><a href="apidocs/org/wamblee/classloading/package-summary.html">Classloading</a></li>
  17         <li><a href="apidocs/org/wamblee/conditions/package-summary.html">Conditions</a></li>
  18         <li><a href="apidocs/org/wamblee/collections/package-summary.html">Collections</a></li>
  19         <li><a href="apidocs/org/wamblee/concurrency/package-summary.html">Concurrency</a></li>
  20         <li><a href="apidocs/org/wamblee/general/package-summary.html">General</a></li>
  21         <li><a href="apidocs/org/wamblee/io/package-summary.html">IO</a></li>
  22                 <li><a href="apidocs/org/wamblee/ioc/package-summary.html">IOC</a></li>
  23         <li><a href="apidocs/org/wamblee/observer/package-summary.html">Observer</a></li>
  24         <li><a href="apidocs/org/wamblee/persistence/package-summary.html">Persistence</a></li>
  25         <li><a href="apidocs/org/wamblee/reflection/package-summary.html">Reflection</a></li>
  26         <li><a href="apidocs/org/wamblee/xml/package-summary.html">XML</a></li>
  27       </ul>
  28     </section>
  29
  30     <section name="Maven POM configuration">
  31       <p>The following maven dependency must be used:</p>
  32       <table>
  33         <tr>
  34           <th>groupId</th>
  35           <th>artifactId</th>
  36         </tr>
  37         <tr>
  38           <td>org.wamblee</td>
  39           <td>wamblee-support-general</td>
  40         </tr>
  41       </table>
  42       <p>In addition there are optional dependencies on the following maven artifacts that need only
  43       be used when EhCache utlities are used: </p>
  44       <table>
  45         <tr>
  46           <th>groupId</th>
  47           <th>artifactId</th>
  48           <th>version</th>
  49         </tr>
  50         <tr>
  51           <td>net.sf.ehcache</td>
  52           <td>ehcache-core</td>
  53           <td>2.2.0</td>
  54         </tr>
  55       </table>
  56     </section>
  57
  58   </body>
  59 </document>