blob: 58572bf167ffa6447a1196e45ab5026f9ff5291d [file] [log] [blame]
<html>
<title>Which environment checking utility</title>
<body>
<p>Which is a simple utility that inspects your JVM's environment and reports simple info about versions of classes found.</p>
<dl>
<dt><b>Author: </b></dt><dd><a href="mailto:curcuru@apache.org">curcuru@apache.org</a></dd>
<dt><b>See: </b>(overview)</dt><dd><a href="http://xml.apache.org/commons/">xml-commons project</a> for an overview.</dd>
<dt><b>Usage: </b>(common)</dt><dd>
<code>set CLASSPATH=%CLASSPATH%;which.jar<br/>
java org.apache.env.Which [project;WhichProject] [-options]</code></dd>
<dt><b>Usage: </b>(more examples)</dt><dd>{@link org.apache.env.Which}</dd>
</dl>
<p>This package is a somewhat simplistic environment checking
utility. It allows users in various environments to self-test
their specific deployed environment to ensure that they have the
correct classes present. Which is currently focused on various
XML issues but is architected to be generic and easily extensible.</p>
<p>Most of the documentation is included in the Javadocs for the
various classes. Which is a framework into which various 'checkers'
or WhichProject implementations can be plugged; it then asks each
implementation to fill in whatever information it can into a common
Hashtable, which it then reports back to the user in one of a number
of formats.</p>
<p>Most useful for reporting environments in automated builds or
for a self-help system version detection for users reporting bugs.</p>
</body>
</html>