You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by jk...@apache.org on 2002/08/16 00:05:19 UTC
cvs commit: jakarta-commons/cli/src/test/org/apache/commons/cli BugsTest.java
jkeyes 2002/08/15 15:05:19
Modified: cli/src/java/org/apache/commons/cli GnuParser.java
Option.java OptionBuilder.java PosixParser.java
cli/src/test/org/apache/commons/cli BugsTest.java
Log:
bug no. 11456 - optional argument values implemented
Revision Changes Path
1.6 +5 -5 jakarta-commons/cli/src/java/org/apache/commons/cli/GnuParser.java
Index: GnuParser.java
===================================================================
RCS file: /home/cvs/jakarta-commons/cli/src/java/org/apache/commons/cli/GnuParser.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- GnuParser.java 14 Aug 2002 22:27:39 -0000 1.5
+++ GnuParser.java 15 Aug 2002 22:05:18 -0000 1.6
@@ -184,7 +184,7 @@
public void processArgs( Option opt, ListIterator iter )
throws ParseException
{
- if( !iter.hasNext() ) {
+ if( !iter.hasNext() && !opt.hasOptionalArg() ) {
throw new MissingArgumentException( "no argument for:" + opt.getOpt() );
}
// loop until an option is found
@@ -261,7 +261,7 @@
}
// if the option takes an argument value
- if ( opt.hasArg() ) {
+ if ( opt.hasArg() ) {
processArgs( opt, iter );
}
1.10 +23 -0 jakarta-commons/cli/src/java/org/apache/commons/cli/Option.java
Index: Option.java
===================================================================
RCS file: /home/cvs/jakarta-commons/cli/src/java/org/apache/commons/cli/Option.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- Option.java 14 Aug 2002 22:27:39 -0000 1.9
+++ Option.java 15 Aug 2002 22:05:18 -0000 1.10
@@ -106,6 +106,8 @@
/** required specifies whether this option is required to be present */
private boolean required = false;
+ private boolean optionalArg = false;
+
/**
* numberOfArgs specifies the number of argument values this option
* can have
@@ -254,6 +256,26 @@
public void setLongOpt( String longOpt ) {
this.longOpt = longOpt;
}
+
+ /**
+ * Sets whether this Option can have an optional argument.
+ *
+ * @param optionalArg specifies whether the Option can have
+ * an optional argument.
+ */
+ public void setOptionalArg( boolean optionalArg ) {
+ if( optionalArg ) {
+ this.numberOfArgs = 1;
+ }
+ this.optionalArg = optionalArg;
+ }
+
+ /**
+ * @return whether this Option can have an optional argument
+ */
+ public boolean hasOptionalArg( ) {
+ return this.optionalArg;
+ }
/** <p>Query to see if this Option has a long name</p>
*
@@ -438,6 +460,7 @@
public Object clone() {
Option option = new Option( getOpt(), getDescription() );
option.setArgs( getArgs() );
+ option.setOptionalArg( hasOptionalArg() );
option.setRequired( isRequired() );
option.setLongOpt( getLongOpt() );
option.setType( getType() );
1.5 +15 -3 jakarta-commons/cli/src/java/org/apache/commons/cli/OptionBuilder.java
Index: OptionBuilder.java
===================================================================
RCS file: /home/cvs/jakarta-commons/cli/src/java/org/apache/commons/cli/OptionBuilder.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- OptionBuilder.java 4 Aug 2002 23:04:52 -0000 1.4
+++ OptionBuilder.java 15 Aug 2002 22:05:18 -0000 1.5
@@ -83,6 +83,7 @@
/** option type */
private static Object type;
+ private static boolean optionalArg;
private static char valuesep;
/** option builder instance */
@@ -223,6 +224,16 @@
}
/**
+ * <p>The next Option can have an optional argument.</p>
+ *
+ * @return the OptionBuilder instance
+ */
+ public static OptionBuilder hasOptionalArg( ) {
+ instance.optionalArg = true;
+ return instance;
+ }
+
+ /**
* <p>The next Option created will have a value that will be an instance
* of <code>type</code>.</p>
*
@@ -279,6 +290,7 @@
// set the option properties
option.setLongOpt( longopt );
option.setRequired( required );
+ option.setOptionalArg( optionalArg );
option.setArgs( numberOfArgs );
option.setType( type );
option.setValueSeparator( valuesep );
1.7 +6 -50 jakarta-commons/cli/src/java/org/apache/commons/cli/PosixParser.java
Index: PosixParser.java
===================================================================
RCS file: /home/cvs/jakarta-commons/cli/src/java/org/apache/commons/cli/PosixParser.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- PosixParser.java 14 Aug 2002 22:27:39 -0000 1.6
+++ PosixParser.java 15 Aug 2002 22:05:18 -0000 1.7
@@ -181,33 +181,12 @@
// to be the argument value
// if there is no argument value
- if( token.substring(i+1).length() == 0 ) {
+ if( token.substring(i+1).length() == 0 && !opt.hasOptionalArg() ) {
throw new MissingArgumentException( "Missing argument value for " + opt.getOpt() );
}
-
- /*
- String var = token.substring(i+1);
- char sep = opt.getValueSeparator();
-
- if( sep > 0 ) {
- int findex;
- while( ( findex = var.indexOf( sep ) ) != -1 ) {
- String val = var.substring( 0, findex );
- var = var.substring( findex + 1);
- if( !opt.addValue( val ) ) {
- cmd.addArg( val );
- }
- }
- if( !opt.addValue( var ) ) {
- cmd.addArg( var );
- };
- }
else {
- // add the argument value
opt.addValue( token.substring(i+1) );
}
- */
- opt.addValue( token.substring(i+1) );
// set the option
cmd.setOpt( opt );
@@ -261,7 +240,7 @@
throws ParseException
{
// get the option represented by arg
- Option opt = null;//(Option) options.getOption( arg );
+ Option opt = null;
boolean hasOption = options.hasOption( arg );
@@ -304,7 +283,7 @@
public void processArgs( Option opt, ListIterator iter )
throws ParseException
{
- if( !iter.hasNext() ) {
+ if( !iter.hasNext() && !opt.hasOptionalArg() ) {
throw new MissingArgumentException( "no argument for:" + opt.getOpt() );
}
// loop until an option is found
@@ -319,29 +298,6 @@
}
// its a value
else {
- /*
- char sep = opt.getValueSeparator();
-
- if( sep > 0 ) {
- int findex;
- while( ( findex = var.indexOf( sep ) ) != -1 ) {
- String val = var.substring( 0, findex );
- var = var.substring( findex + 1);
- if( !opt.addValue( val ) ) {
- iter.previous();
- return;
- }
- }
- if( !opt.addValue( var ) ) {
- iter.previous();
- return;
- };
- }
- else if( !opt.addValue( var ) ) {
- iter.previous();
- return;
- }
- */
if( !opt.addValue( var ) ) {
iter.previous();
break;
1.2 +40 -1 jakarta-commons/cli/src/test/org/apache/commons/cli/BugsTest.java
Index: BugsTest.java
===================================================================
RCS file: /home/cvs/jakarta-commons/cli/src/test/org/apache/commons/cli/BugsTest.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BugsTest.java 15 Aug 2002 20:31:23 -0000 1.1
+++ BugsTest.java 15 Aug 2002 22:05:19 -0000 1.2
@@ -60,7 +60,46 @@
catch( ParseException exp ) {
fail( "Unexpected Exception: " + exp.getMessage() );
}
+ }
+
+ public void test11456()
+ {
+ // Posix
+ Options options = new Options();
+ options.addOption( OptionBuilder.hasOptionalArg()
+ .create( 'a' ) );
+ options.addOption( OptionBuilder.hasArg()
+ .create( 'b' ) );
+ String[] args = new String[] { "-a", "-bvalue" };
+
+ CommandLineParser parser = CommandLineParserFactory.newParser();
+
+ try {
+ CommandLine cmd = parser.parse( options, args );
+ assertEquals( cmd.getOptionValue( 'b' ), "value" );
+ }
+ catch( ParseException exp ) {
+ fail( "Unexpected Exception: " + exp.getMessage() );
+ }
+ // GNU
+ options = new Options();
+ options.addOption( OptionBuilder.hasOptionalArg()
+ .create( 'a' ) );
+ options.addOption( OptionBuilder.hasArg()
+ .create( 'b' ) );
+ args = new String[] { "-a", "-b", "value" };
+
+ parser = CommandLineParserFactory.newParser( "org.apache.commons.cli.GnuParser" );
+
+ try {
+ CommandLine cmd = parser.parse( options, args );
+ assertEquals( cmd.getOptionValue( 'b' ), "value" );
+ }
+ catch( ParseException exp ) {
+ fail( "Unexpected Exception: " + exp.getMessage() );
+ }
}
+
}
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>