The Jakarta Commons Lang Component

1. INTRODUCTION

The Lang Component contains a set of Java classes that provide a basic set of common utility code on top of the standard Java classes. The following principal classes are included:

• Main package - A package for the manipulation of basic Java classes
  • ArrayUtils - Helper for manipulating arrays.
  • BooleanUtils - Helper for boolean and java.lang.Boolean.
  • CharSetUtils - Methods for dealing with CharSets, which are sets of characters such as [a-z] and [abcdez].
  • ClassUtils - Helper for manipulating java.lang.Class objects.
  • ObjectUtils - Helper for java.lang.Object.
  • RandomStringUtils - Helper for creating randomised Strings.
  • SerializationUtils - Helper for serializing Objects.
  • StringEscapeUtils - Utility for escaping and unescaping Strings.
  • StringUtils - Helper for java.lang.String.
  • SystemUtils - Utility class defining the Java system properties.
  • WordWrapUtils - Utility for working with words.
• Builder package - A package for the creation of equals, hashCode, compareTo and toString methods.
  • ToStringBuilder - Helper for building toString methods.
  • EqualsBuilder - Helper for building equals methods.
  • HashCodeBuilder - Helper for building hashCode methods.
  • CompareToBuilder - Helper for building compareTo methods.
• Enum package - A package for the creation of enumerated types.
  • EnumUtils - Helper for manipulating enumerated types.
  • Enum - Abstract superclass for enumerated types to extend.
  • ValuedEnum - Superclass for enumerated types with an integer constant.
• Exception package - A package for the creation and manipulation of nested exceptions.
• ExceptionUtils - Helper for manipulating exceptions.
• NestableException - An exception that supports a nested exception.
• NestedRuntimeException - An exception that supports a nested exception.
• NestedError - An exception that supports a nested exception.
• Math package - A package for simple business (not scientific) maths classes.
  • Fraction - A fraction.
  • JVMRandom - An implementation of Random that does its best to appear to sit on top of java.lang.Math's private Random class.
  • NumberUtils - Helper for java.lang.Number and its subclasses.
  • Range - A range of numbers<, of which there are classes representing Numbers, ints, doubles, longs and floats./li>
  • RandomUtils - A utility class for working with random numbers.
• Time package - A package for date/time related utilities.
  • DateFormatUtils - Aids in formatting Dates.
  • DateUtils - Aids in manipulating Dates.
  • FastDateFormat - Optimised version of SimpleDateFormat.
  • StopWatch - Records durations, represented by milliseconds.
• Util package - A package for common useful utilities.
  • BitField - A class to assist with manipulating bits.
  • IdentifierUtils - Implementation of various identifier factories.
  • Validate - A class to simplify method argument validation.

2. DEPENDENCIES

The Lang component is dependent upon the following external components for development and use:

• Java Development Kit (Version 1.2 or later)
• JUnit Testing Framework (Version 3.7 or later) - for unit tests only, not required for deployment

3. RELEASE INFO

Current Release: Version 2.0

Planned Next Release: Unknown.

4. KNOWN ISSUES

• CharRange.UNSET - will have problems if we introduce reverse ranges that go down to \u0000.
• Null effects - the classes are not standardised in how they handle null.

5. ACTION ITEMS

Want to help? Here's some "to do" items the team has identified as possibly being in scope for Lang. Note that all are still under discussion, so please mail the list before actioning.

• Reflection utilities - work underway in reflect package.
• DateRange/Duration class
• DurationFormatUtils to be completed and made public
• CloneUtils - utility class to enable cloning via various different mechanisms. This code exists in [pattern] at present.
• StringUtils.reverseSplit(String, String delim, int count). Should basically be a 'reverseArray(reverseDelimitedString(split(txt, delim, count)))
• CharUtils - Utilities to work on a char[] in the same way as a String
• AStringBuffer - A StringBuffer implementation with additional methods from StringUtils
• O(n) - Document all algorithm-implementing methods with the order. Possibly with an O(n) on the end of each parameterm or with an @order tag.
• Money and Currency
• Code examples - Document as many static methods as possible with example usage.
• Faster StringTokeniser - Is Java's slow?

6. COMMITTERS

The following individuals are the primary developers and maintainers of this component. Developers who plan to use Lang in their own projects are encouraged to collaborate on the future development of this component to ensure that it continues to meet a variety of needs.

• Henri Yandell
• Daniel Rall
• Stephen Colebourne
• Steven Caswell
• Robert Burrell Donkin
• Gary Gregory