XBN Java: Generically useful, non-GUI Java code: Overview

Overview

Package

Class

Tree

Index

Help

PREV NEXT

FRAMES NO FRAMES

XBN Java
`http://sourceforge.net/projects/xbnjava`

XBN Java is an large collection of generically useful, non-GUI Java code.

See:
Description

Core XBN Packages

xbn Stuff used by practically everything else.

xbn.array Create, analyze and manipulate arrays.

xbn.config Read in variables from provided source text.

xbn.db Manage and use database connections.

xbn.jdlcode Speed up the creation and increase the accuracy of your JavaDoc.

xbn.named Classes that deal with objects having a name associated to it.

xbn.output Output text to a variety of destinations, optionally and with complete configuration.

xbn.placeholder Intended to be used only as "placeholders", by functions needing to return multiple things at once.

xbn.programs Standalone applications, and classes useful for creating them.

xbn.string Create, analyze and manipulate strings, strings and other things.

xbn.string.escape Escape and unescape characters in a string.

xbn.string.padchop Pad and/or chop strings to a desired size.

xbn.template Separate functional and visual responsibilities through the use of "templates".

xbn.template.util Create, manipulate and analyze Templates.

xbn.util Random utility classes to be used by any random thing for any random purpose.

Example code

xbn_examples.array Example code for xbn.array.

xbn_examples.config Example code for xbn.config.

xbn_examples.db Example code for xbn.db.

xbn_examples.jdlcode Example code for xbn.jdlcode.

xbn_examples.programs More significant (and potentially useful) example code based upon XBN Java.

xbn_examples.template Example code for xbn.template.

xbn_examples.template.util Example code for xbn.template.util.

xbn_examples.util Example code for xbn.util.

Deprecated Packages

xbn.array.primitive (Deprecated: This package is messy and is going away, although it's basic concepts will be re-implemented somehow, someday, someway) Classes used to wrap anything, in the interest of making it appear like an array of primitive values (including strings).

XBN Java is an large collection of generically useful, non-GUI Java code. It has been in development since 1997.

TOP

... Download and install XBN Java, and learn what it depends upon.
... Secondary documentation
... Copyright notice: XBN Java is released under the BSD License (with no advertising clause).

The current version: 0.9b, as of Monday, July 05, 2004

XBN Java is hosted by sourceforge.net.

... Project page

... Latest documentation at xbnjava.sourceforge.net

... Downloads

... CVS access

... User forums

... Mailing lists

... Bug database

... Request an enhancement

... News

TOP Downloads, installation and dependencies

Download the latest version of XBN Java directly from xbnjava.sourceforge.net.

What Approx Kb Description External Dependencies
xbn-0.9b.jar 313 All xbn.* classes. CLI 1.0 (only for xbn.programs)
xbn_all_classes-0.9b.jar 377 Everything in xbn-0.9b.jar, plus xbn_junit.* and xbn_examples.* JUnit 1.8.2, CLI
xbnjava_source_code-0.9b.zip 712 XBN Java source code, and most build-files. Note that these files have been manipulated for web-viewing, and therefore cannot be used for building.
xbnjava_dependency_jars-0.9b.zip 132 All jar files dependened on by the XBN Java build process.
xbnjava_build_nojars-0.9b.zip 630 Everything necessary to build XBN Java from scratch, except dependency jar files. Those exist in xbnjava_dependency_jars-0.9b.zip. Ant 1.5.3, CLI, JUnit
xbnjava_documentation-0.9b.zip 1125 All documentation. Note that, throughout this documentation, there are many links to source code (links with "/CODE/" in the url). These links will not work until you explode xbnjava_source_code-0.9b.zip into the same directory.

Most dependencies are already in etcetera/dependencies

Installation

To use:

Install Sun's Java Runtime Environment, version 1.3.1 or higher. Click on DOWNLOAD underneath "JRE" and to the right of your proper platform.
Whichever xbn*.jar you download, put it in your CLASSPATH (create the env var if it doesn't yet exist). For example:
- Old CLASSPATH: .;C:\my_classes
- New CLASSPATH: .;C:\my_classes;C:\wherever\the\jar\exists\xbn*.jar
If your chosen xbn*.jar has a dependency, install it as well, according to its instructions.
Use the xbn packages in your own code.

To build:

Install the Java Runtime Environment, version 1.3.1 (exactly).
Fully install Ant 1.5.4 (or compatible), and be sure to put optional.jar into your CLASSPATH.
If you're going to use IBM's Jikes compiler in place of javac (recommended, it's much faster), then you need to install it.
In the directory in which you exploded the XBN Java source code (assume E:\a_sandbox\xbnjava\), exists the file xbn.properties. Alter these properties as appropriate for your environment.
Unfortunately, I'm having trouble passing in any classpath (either as a ref or explicitely) into the javadoc Ant task. Therefore, you must also explicitely put E:\a_sandbox\xbnjava\etcetera\dependencies\commons-cli-1.0.jar into your
Open a command-line application (like command.com), go to E:\a_sandbox\xbnjava\, and type ant.

Notes

The build process is dependent on everything listed in the above dependency column, and also every java file existing in etcetera/dependencies (which are custom Ant tasks).

Although not necessary, I also recommend HTML Power Analyzer, to report broken links in your JavaDoc. For that matter, I recommend TextPad, instead of the IDE or text editor that you use :' ).

These packages are compiled in JDK 1.3.1. This was upgraded to Java 1.4, but reverted back to 1.3. The reason being that 1.4's JavaDoc process completely suppresses all 'at' tags (@param, @return, @author, @exception, ...).:' (

Check out the 'javadoc' task. I can't figure out how to make the 'link' parameter work when I'm not online (and I've not yet been successful with the linkoffline parameter). Therefore it's commented out, and you need to uncomment them to have links to external code in the JavaDoc.

Getting started with CVS at sourceforge.net:

Follow this documentation very carefully. If anything goes wrong, it's best to uninstall everything and start over.
Say your CVS root directory is cvsroot/xbnjava/, when asked for which directory name to import your project to, provide '.'.

TOP Unit test notes

All unit tests are located in the xbn_junit packages.

Naming convention: Generally 'JUT[class-name]', where 'JUT' stands for JUnit test. In the case of a package, it's 'JUT_[package-name-in-upper-case]'. Except in rare exceptions, the 'package' JUnits are nothing more than suites to call its children.

Organization: Generally a mirror to the overall XBN Java package structure, where each package JUnit calls both the class JUnits in its package, as well as the sub-package JUnits. Executing a package JUnit calls all JUnits in its package, and all sub-package JUnits. Executing a class JUnit executes it only.

JACTAF: 'Just a call to another function'. You'll find this scattered throughout the source code, implying that particular test is a minimal one.

BACK Copyright notice

View the full text of the BSD License.

XBN Java:  Generically useful, non-GUI Java code.

http://sourceforge.net/projects/xbnjava



Copyright (C) 1997-2003, Jeff Epstein

All rights reserved.



Modifications: No



Redistribution in binary form, with or without modifications, are permitted provided that the following conditions are met:



   * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

   * If modifications are made to source code then this license should indicate that fact in the "Modifications" section above.

   * Neither the author, nor the contributors may be used to endorse or promote products derived from this software without specific prior written permission.



THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.



[NOTE:  This license contains NO advertising clause.]