Represents list of arguments parsed against * a {@link Options} descriptor.
* *
It allows querying of a boolean {@link #hasOption(String opt)}, * in addition to retrieving the {@link #getOptionValue(String opt)} * for options requiring arguments.
* *Additionally, any left-over or unrecognized arguments, * are available for further processing.
* * @author bob mcwhirter (bob @ werken.com) * @author James Strachan * @author John Keyes (john at integralsource.com) */ public class CommandLine { /** the unrecognised options/arguments */ private List args = new LinkedList(); /** the processed options */ private Map options = new HashMap(); /** Map of unique options for ease to get complete list of options */ private Map hashcodeMap = new HashMap(); /** the processed options */ private Option[] optionsArray; /** *Creates a command line.
*/ CommandLine() { } /** *Query to see if an option has been set.
* * @param opt Short name of the option * @return true if set, false if not */ public boolean hasOption(String opt) { return options.containsKey( opt ); } /** *Query to see if an option has been set.
* * @param opt character name of the option * @return true if set, false if not */ public boolean hasOption( char opt ) { return hasOption( String.valueOf( opt ) ); } /** *Return the Object type of this Option.
Option
*/
public Object getOptionObject( String opt ) {
String res = getOptionValue( opt );
Object type = ((Option)((List)options.get(opt)).iterator().next()).getType();
return res == null ? null : TypeHandler.createValue(res, type);
}
/**
* Return the Object type of this Option.
Retrieve the argument, if any, of this option.
* * @param opt the name of the option * @return Value of the argument if option is set, and has an argument, * otherwise null. */ public String getOptionValue( String opt ) { String[] values = getOptionValues(opt); return (values == null) ? null : values[0]; } /** *Retrieve the argument, if any, of this option.
* * @param opt the character name of the option * @return Value of the argument if option is set, and has an argument, * otherwise null. */ public String getOptionValue( char opt ) { return getOptionValue( String.valueOf( opt ) ); } /** *Retrieves the array of values, if any, of an option.
* * @param opt string name of the option * @return Values of the argument if option is set, and has an argument, * otherwise null. */ public String[] getOptionValues( String opt ) { List values = new java.util.ArrayList(); if( options.containsKey( opt ) ) { List opts = (List)options.get( opt ); Iterator iter = opts.iterator(); while( iter.hasNext() ) { Option optt = (Option)iter.next(); values.addAll( optt.getValuesList() ); } } return (values.size() == 0) ? null : (String[])values.toArray(new String[]{}); } /** *Retrieves the array of values, if any, of an option.
* * @param opt character name of the option * @return Values of the argument if option is set, and has an argument, * otherwise null. */ public String[] getOptionValues( char opt ) { return getOptionValues( String.valueOf( opt ) ); } /** *Retrieve the argument, if any, of an option.
* * @param opt name of the option * @param defaultValue is the default value to be returned if the option is not specified * @return Value of the argument if option is set, and has an argument, * otherwisedefaultValue.
*/
public String getOptionValue( String opt, String defaultValue ) {
String answer = getOptionValue( opt );
return ( answer != null ) ? answer : defaultValue;
}
/**
* Retrieve the argument, if any, of an option.
* * @param opt character name of the option * @param defaultValue is the default value to be returned if the option is not specified * @return Value of the argument if option is set, and has an argument, * otherwisedefaultValue.
*/
public String getOptionValue( char opt, String defaultValue ) {
return getOptionValue( String.valueOf( opt ), defaultValue );
}
/**
* Retrieve any left-over non-recognized options and arguments
* * @return remaining items passed in but not parsed as an array */ public String[] getArgs() { String[] answer = new String[ args.size() ]; args.toArray( answer ); return answer; } /** *Retrieve any left-over non-recognized options and arguments
* * @return remaining items passed in but not parsed as aList.
*/
public List getArgList() {
return args;
}
/**
* jkeyes
* - commented out until it is implemented properly
* Dump state, suitable for debugging.
* * @return Stringified form of this object */ /* public String toString() { StringBuffer buf = new StringBuffer(); buf.append( "[ CommandLine: [ options: " ); buf.append( options.toString() ); buf.append( " ] [ args: "); buf.append( args.toString() ); buf.append( " ] ]" ); return buf.toString(); } */ /** *Add left-over unrecognized option/argument.
* * @param arg the unrecognised option/argument. */ void addArg(String arg) { args.add( arg ); } /** *Add an option to the command line. The values of * the option are stored.
* * @param opt the processed option */ void addOption( Option opt ) { hashcodeMap.put( new Integer( opt.hashCode() ), opt ); String key = opt.getOpt(); if( " ".equals(key) ) { key = opt.getLongOpt(); } if( options.get( key ) != null ) { ((java.util.List)options.get( key )).add( opt ); } else { options.put( key, new java.util.ArrayList() ); ((java.util.List)options.get( key ) ).add( opt ); } } /** *Returns an iterator over the Option members of CommandLine.
* * @return anIterator over the processed {@link Option}
* members of this {@link CommandLine}
*/
public Iterator iterator( ) {
return hashcodeMap.values().iterator();
}
/**
* Returns an array of the processed {@link Option}s.
* * @return an array of the processed {@link Option}s. */ public Option[] getOptions( ) { Collection processed = hashcodeMap.values(); // reinitialise array optionsArray = new Option[ processed.size() ]; // return the array return (Option[]) processed.toArray( optionsArray ); } }