org.apache.commons.cli.avalon
Class CLUtil

java.lang.Object
  org.apache.commons.cli.avalon.CLUtil

public final class CLUtil
extends Object

CLUtil offers basic utility operations for use both internal and external to package.

Version:

$Revision: 1.2 $ $Date: 2005/03/18 15:26:55 $

See Also:

CLOptionDescriptor

Method Summary

static StringBuffer

describeOptions(CLOptionDescriptor[] options) Format options into StringBuffer and return.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

describeOptions

public static final StringBuffer describeOptions(CLOptionDescriptor[] options)

Format options into StringBuffer and return. This is typically used to print "Usage" text in response to a "--help" or invalid option.

Parameters:

options - the option descriptors

Returns:

the formatted description/help for options