Parser creates {@link CommandLine}s.
Subclasses must implement this method to reduce
* the arguments that have been passed to the parse
* method.
Parses the specified arguments
* based on the specifed {@link Options}.
Options
* @param arguments the arguments
* @return the CommandLine
* @throws ParseException if an error occurs when parsing the
* arguments.
*/
public CommandLine parse( Options options, String[] arguments )
throws ParseException
{
return parse( options, arguments, false );
}
/**
* Parses the specified arguments
* based on the specifed {@link Options}.
Options
* @param arguments the arguments
* @param stopAtNonOption specifies whether to stop
* interpreting the arguments when a non option has
* been encountered and to add them to the CommandLines
* args list.
* @return the CommandLine
* @throws ParseException if an error occurs when parsing the
* arguments.
*/
public CommandLine parse( Options opts,
String[] arguments,
boolean stopAtNonOption )
throws ParseException
{
// initialise members
options = opts;
requiredOptions = options.getRequiredOptions();
cmd = new CommandLine();
boolean eatTheRest = false;
List tokenList = Arrays.asList( flatten( opts, arguments, stopAtNonOption ) );
ListIterator iterator = tokenList.listIterator();
// process each flattened token
while( iterator.hasNext() ) {
String t = (String)iterator.next();
// the value is the double-dash
if( "--".equals( t ) ) {
eatTheRest = true;
}
// the value is a single dash
else if( "-".equals( t ) ) {
if( stopAtNonOption ) {
eatTheRest = true;
}
else {
cmd.addArg(t );
}
}
// the value is an option
else if( t.startsWith( "-" ) ) {
if ( stopAtNonOption && !options.hasOption( t ) ) {
eatTheRest = true;
cmd.addArg( t );
}
else {
processOption( t, iterator );
}
}
// the value is an argument
else {
cmd.addArg( t );
if( stopAtNonOption ) {
eatTheRest = true;
}
}
// eat the remaining tokens
if( eatTheRest ) {
while( iterator.hasNext() ) {
String str = (String)iterator.next();
// ensure only one double-dash is added
if( !"--".equals( str ) ) {
cmd.addArg( str );
}
}
}
}
checkRequiredOptions();
return cmd;
}
/**
* Throws a {@link MissingOptionException} if all of the * required options are no present.
*/ private void checkRequiredOptions() throws MissingOptionException { // if there are required options that have not been // processsed if( requiredOptions.size() > 0 ) { Iterator iter = requiredOptions.iterator(); StringBuffer buff = new StringBuffer(); // loop through the required options while( iter.hasNext() ) { buff.append( iter.next() ); } throw new MissingOptionException( buff.toString() ); } } public void processArgs( Option opt, ListIterator iter ) throws ParseException { // loop until an option is found while( iter.hasNext() ) { String var = (String)iter.next(); // found an Option if( options.hasOption( var ) ) { iter.previous(); break; } // found a value else if( !opt.addValue( var ) ) { iter.previous(); break; } } if( opt.getValues() == null && !opt.hasOptionalArg() ) { throw new MissingArgumentException( "no argument for:" + opt.getOpt() ); } } private void processOption( String arg, ListIterator iter ) throws ParseException { // get the option represented by arg Option opt = null; boolean hasOption = options.hasOption( arg ); // if there is no option throw an UnrecognisedOptionException if( !hasOption ) { throw new UnrecognizedOptionException("Unrecognized option: " + arg); } else { opt = (Option) options.getOption( arg ); } // if the option is a required option remove the option from // the requiredOptions list if ( opt.isRequired() ) { requiredOptions.remove( "-" + opt.getOpt() ); } // if the option is in an OptionGroup make that option the selected // option of the group if ( options.getOptionGroup( opt ) != null ) { OptionGroup group = ( OptionGroup ) options.getOptionGroup( opt ); if( group.isRequired() ) { requiredOptions.remove( group ); } group.setSelected( opt ); } // if the option takes an argument value if ( opt.hasArg() ) { processArgs( opt, iter ); } // set the option on the command line cmd.addOption( opt ); } }