Update of /cvsroot/commonjava/commonjava-projects/commonjava-console
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv26752
Modified Files:
project.xml
Log Message:
updated documentation in project.xml files, and added functionality to:
Console:
- provide convenient way to prompt the user for more information
Config:
- Provide snap-in container stacking, or scoping
- Provide a JBoss service implementation of a snap-in container
Probably other things, but I don't honestly remember everything...
Index: project.xml
===================================================================
RCS file: /cvsroot/commonjava/commonjava-projects/commonjava-console/project.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- project.xml 18 Sep 2003 00:46:59 -0000 1.1
+++ project.xml 18 Feb 2004 06:12:31 -0000 1.2
@@ -3,9 +3,9 @@
<project>
<pomVersion>3</pomVersion>
<id>commonjava-console</id>
- <name>CommonJava Console Framework</name>
+ <name>Console Framework</name>
<groupId>commonjava</groupId>
- <currentVersion>2.0</currentVersion>
+ <currentVersion>2.0-1</currentVersion>
<organization>
<name>CommonJava Open Component Project</name>
<url>http://www.commonjava.org</url>
@@ -13,6 +13,26 @@
<inceptionYear>2002</inceptionYear>
<package>org.commonjava.console</package>
+ <description>
+ Console Framework is getopt on steroids. It contains object formatters, which transform a string
+ read from the command line into any number of object types, along with providing validation that
+ that string conforms to the definition of a valid instance of that type. It contains a Command
+ base object, which can accept multiple command line templates which each define a combination of
+ command-line options that constitute a valid invocation. Command-line templates are merely arrays
+ of Option instances, which in turn are specifications of a short name (invoked as '-f xxx'),
+ a long name (invoked as "--file=xxx"), possibly an OptionFormat value (these are a
+ pseudo-enumerated type with added functionality outlined above), and a description of what the
+ option means to the command line. The command itself is instantiated with a description of what
+ it does, plus an optional description of what the non-option arguments mean to the invocation.
+ In addition, the empty command template can be en/disabled (invocation with no options), and the
+ in/out/err streams can be set.
+
+ Built on top of all this is the notion of a Console, which accepts and parses a command invocation
+ from somewhere into an array of strings (static void main(String[] args) style), and then looks
+ up the appropriate command instance and invokes it with the options. The BasicConsole has a help
+ command built in, which shows all available commands and their associated usages.
+ </description>
+
<dependencies>
<dependency>
<groupId>commonjava</groupId>
|
