bayard 2004/08/21 19:37:34
Modified: cli/src/java/org/apache/commons/cli
PatternOptionBuilder.java
Log:
improved javadoc info describing how to use PatternOptionBuilder
Revision Changes Path
1.11 +21 -1
jakarta-commons/cli/src/java/org/apache/commons/cli/PatternOptionBuilder.java
Index: PatternOptionBuilder.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/cli/src/java/org/apache/commons/cli/PatternOptionBuilder.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- PatternOptionBuilder.java 17 Aug 2004 13:51:36 -0000 1.10
+++ PatternOptionBuilder.java 22 Aug 2004 02:37:34 -0000 1.11
@@ -16,10 +16,30 @@
package org.apache.commons.cli;
/**
+ * <p>
* Allows Options to be created from a single String.
+ * The pattern contains various single character flags and via
+ * an optional punctuation character, their expected type.
+ * </p>
*
+ * <table border="1">
+ * <tr><td>a</td><td>-a flag</td></tr>
+ * <tr><td>b@</td><td>-b [classname]</td></tr>
+ * <tr><td>c></td><td>-c [filename]</td></tr>
+ * <tr><td>d+</td><td>-d [classname] (creates object via empty contructor)</td></tr>
+ * <tr><td>e%</td><td>-e [number] (creates Number instance)</td></tr>
+ * <tr><td>f/</td><td>-f [url]</td></tr>
+ * </table>
+ *
+ * <p>
+ * For example, the following allows command line flags of '-v -p string-value -f
/dir/file'.
+ * </p>
+ * <code>Options options = PatternOptionBuilder.parsePattern("vp:f/");</code>
+ *
+ * <p>
* TODO These need to break out to OptionType and also
* to be pluggable.
+ * </p>
*
* @author Henri Yandell (bayard @ generationjava.com)
* @version $Revision$
@@ -185,4 +205,4 @@
return options;
}
-}
\ No newline at end of file
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
