OptionBuilder allows the user to create Options using descriptive * methods.
*Details on the Builder pattern can be found at * http://c2.com/cgi-bin/wiki?BuilderPattern.
* * @author John Keyes ( john at integralsource.com ) * @since 1.0 */ public class OptionBuilder { /** long option */ private static String longopt; /** option description */ private static String description; /** argument name */ private static String argName; /** is required? */ private static boolean required; /** the number of arguments */ private static int numberOfArgs = Option.UNINITIALIZED; /** option type */ private static Object type; /** option can have an optional argument value */ private static boolean optionalArg; /** value separator for argument value */ private static char valuesep; /** option builder instance */ private static OptionBuilder instance = new OptionBuilder(); // private constructor private OptionBuilder() { } /** *Resets the member variables to their default values.
*/ private static void reset() { description = null; argName = null; longopt = null; type = null; required = false; numberOfArgs = Option.UNINITIALIZED; // PMM 9/6/02 - these were missing optionalArg = false; valuesep = (char) 0; } /** *The next Option created will have the following long option value.
* * @param longopt the long option value * @return the OptionBuilder instance */ public static OptionBuilder withLongOpt( String longopt ) { instance.longopt = longopt; return instance; } /** *The next Option created will require an argument value.
* * @return the OptionBuilder instance */ public static OptionBuilder hasArg( ) { instance.numberOfArgs = 1; return instance; } /** *The next Option created will require an argument value if
* hasArg is true.
The next Option created will have the specified argument value * name.
* * @param name the name for the argument value * @return the OptionBuilder instance */ public static OptionBuilder withArgName( String name ) { instance.argName = name; return instance; } /** *The next Option created will be required.
* * @return the OptionBuilder instance */ public static OptionBuilder isRequired( ) { instance.required = true; return instance; } /** *The next Option created uses sep as a means to
* separate argument values.
* Option opt = OptionBuilder.withValueSeparator( ':' )
* .create( 'D' );
*
* CommandLine line = parser.parse( args );
* String propertyName = opt.getValue( 0 );
* String propertyValue = opt.getValue( 1 );
*
*
* @return the OptionBuilder instance
*/
public static OptionBuilder withValueSeparator( char sep ) {
instance.valuesep = sep;
return instance;
}
/**
* The next Option created uses '=' as a means to
* separate argument values.
* Option opt = OptionBuilder.withValueSeparator( )
* .create( 'D' );
*
* CommandLine line = parser.parse( args );
* String propertyName = opt.getValue( 0 );
* String propertyValue = opt.getValue( 1 );
*
*
* @return the OptionBuilder instance
*/
public static OptionBuilder withValueSeparator( ) {
instance.valuesep = '=';
return instance;
}
/**
* The next Option created will be required if required
* is true.
The next Option created can have unlimited argument values.
* * @return the OptionBuilder instance */ public static OptionBuilder hasArgs( ) { instance.numberOfArgs = Option.UNLIMITED_VALUES; return instance; } /** *The next Option created can have num
* argument values.
The next Option can have an optional argument.
* * @return the OptionBuilder instance */ public static OptionBuilder hasOptionalArg( ) { instance.numberOfArgs = 1; instance.optionalArg = true; return instance; } /** *The next Option can have an unlimited number of * optional arguments.
* * @return the OptionBuilder instance */ public static OptionBuilder hasOptionalArgs( ) { instance.numberOfArgs = Option.UNLIMITED_VALUES; instance.optionalArg = true; return instance; } /** *The next Option can have the specified number of * optional arguments.
* * @param numArgs - the maximum number of optional arguments * the next Option created can have. * @return the OptionBuilder instance */ public static OptionBuilder hasOptionalArgs( int numArgs ) { instance.numberOfArgs = numArgs; instance.optionalArg = true; return instance; } /** *The next Option created will have a value that will be an instance
* of type.
The next Option created will have the specified description
* * @param description a description of the Option's purpose * @return the OptionBuilder instance */ public static OptionBuilder withDescription( String description ) { instance.description = description; return instance; } /** *Create an Option using the current settings and with
* the specified Option char.
opt is not
* a valid character. See Option.
*/
public static Option create( char opt )
throws IllegalArgumentException
{
return create( String.valueOf( opt ) );
}
/**
* Create an Option using the current settings
* * @return the Option instance * @throws IllegalArgumentException iflongOpt has
* not been set.
*/
public static Option create()
throws IllegalArgumentException
{
if( longopt == null ) {
throw new IllegalArgumentException( "must specify longopt" );
}
return create( " " );
}
/**
* Create an Option using the current settings and with
* the specified Option char.
java.lang.String representation
* of the Option
* @return the Option instance
* @throws IllegalArgumentException if opt is not
* a valid character. See Option.
*/
public static Option create( String opt )
throws IllegalArgumentException
{
// create the option
Option option = new Option( opt, description );
// set the option properties
option.setLongOpt( longopt );
option.setRequired( required );
option.setOptionalArg( optionalArg );
option.setArgs( numberOfArgs );
option.setType( type );
option.setValueSeparator( valuesep );
option.setArgName( argName );
// reset the OptionBuilder properties
instance.reset();
// return the Option instance
return option;
}
}