GenJar : Java Glossary

GenJar
An open source tool for tracking Java dependencies. It builds jar files that automatically contain all the classes used directly or indirectly by the classes you explicitly include. You need this because jar.exe is not clever enough to do this on its own. GenJar runs only as an ant task. It is a complex tool controlled with an XML (extensible Markup Language) script. It will also build an extended manifest describing all the elements. Of course it has no way of knowing about dynamically loaded classes or resources. The latest version is Genjar2 1.4 Last revised/verified: 2010-11-10
 GenJar stopped working properly with the release of Ant 9.0. I have not yet been able to get GenJar2 working at all. I have questions in to the author.

Installing GenJar2

  1. Install Mercurial (e.g. Tortoise HG) so you can access the Google repository.
  2. Clone the server repository (check out the project) on your local hard drive with a Mercurial command: hg clone https://code.google.com/p/genjar2/ E:\genjar2
  3. Read the manual embedded in the repository, now copied to your local hard disk.
  4. rebuild genjar.jar with build.xml.
  5. Copy genjar.jar and genjar.properties to J:\Program Files (x86)\apache-ant-1.9.0\lib. Everything so far you need do only once.
  6. Compose your <genjar XML ANT (A Neat Tool) script and or incorporate it into an ant build.xml in the project directory with the class files where you want the jar built.
  7. CD (Change Directory) to that project directory.
  8. Then run your script with:
    ant jar
Don’t use the genjar destdir option. It does not produce a simple list of dependencies to feed to jar.exe but rather a copy of the entire directory tree of classes that would go inside the jar.
GenJar error messages are misleading. It will complain about the main class when the real problem is some totally different class.
When genjar says Unable to resolve: null, it means it could not find some class file it needs to include in the jar, or a file it wanted was in use by another program. Try a reboot. You might have some old *.java or *.class files lying about confusing it. Especially check anything with an old date to make sure it should be included. Ahem. It is considered polite when a program complains about being unable to find something to divulge what it is.

Advantages

Disadvantages

What Classes Get Included?

GenJar scans the classpath looking recursively for classes to include in the jar. These it includes in the jar. Classes in the ext directory, by default, it leaves out of the jar.

You can force it to include certain classes or tell it not to include certain classes because they will be supplied at run time in an auxiliary jar.

Real Life Build Script

This build script builds Biorhythms, a signed Applet. You make genjar known to the script with: <taskdef resource=genjar.properties /> Oddly there are no properties to speak of in genjar.properties, just the name of the Java class that extends Task to implement GenJar. 

Here is how you would include a whole directory full of *.png resource images in your jar:

Advanced GenJar

You can use the <library command to unpack and include some other library jar inside your jar. Unfortunately, the <classfilter command has no effect on just what is included with the <library command. Everything is included, needed or not! You have to set up the jar to be included on the classpath, then use the <classfilter. You can use the <class command to include just the stuff from a library needed to support a given class. You can use the <classpath command if GenJar seems to be having trouble finding some auxiliary library.

In this example we persuade GenJar to include just the classes used by the TrueZIP library jar and bundle them in


Recompiling

You might want to recompile GenJar to fix bugs, to figure out how it works etc. You will have to add the Ant jars to the project. GenJar.jar does not have a main-class in the manifest. Ant learns about the genjar.properties file from the taskdef statement in the ant script. It reads it and discovers the class org.apache.tools.ant.taskdefs.optional.genjar.GenJar which extends the abstract Ant Task class. Ant can dynamically load Genjar with Class.forName.asSubClass .newInstance. Ant can then call GenJar’s methods as needed.


CMP homejump to top

available on the web at:

http://mindprod.com/jgloss/genjar.html
  

optional Replicator mirror
of mindprod.com
on local hard disk J:

J:\mindprod\jgloss\genjar.html
logo
Please email your , letters to the editor, errors, omissions, typos, formatting errors, ambiguities, unclear wording, broken/redirected link reports, suggestions to improve this page or comments to Roedy Green : feedback email. If you want your message, your name or email kept confidential, not considered for public posting, please explicitly specify that. Unless you state otherwise, I will treat your message as a letter to the editor that I may or may not publish in the feedback section. After that, it will be too late to retract it. If you disagree with something I said, especially when sending an ad-hominem attack, a rant composed mainly of obscenities or a death threat, please quote the offending passage and cite the web page where you found it, tell me why you think it is wrong, and, if possible, provide some supporting evidence. I can’t very well fix erroneous or ambiguous text if I can’t find it.
Blog
IP:[65.110.21.43]
Your face IP:[107.22.127.92]
You are visitor number 18,157.