options, boolean argumentRequired, String description ) {
super( options, description );
this.argumentRequired = argumentRequired;
}
/**
* Specifies a type to which arguments of this spec's option are to be
* converted.
*
* JOpt Simple accepts types that have either:
*
*
* - a public static method called {@code valueOf} which accepts a single
* argument of type {@link String} and whose return type is the same as the class
* on which the method is declared. The {@code java.lang} primitive wrapper
* classes have such methods.
*
* - a public constructor which accepts a single argument of type
* {@link String}.
*
*
* This class converts arguments using those methods in that order; that is,
* {@code valueOf} would be invoked before a one-{@link String}-arg constructor
* would.
*
* Invoking this method will trump any previous calls to this method or to
* {@link #withValuesConvertedBy(ValueConverter)}.
*
* @param represents the runtime class of the desired option argument type
* @param argumentType desired type of arguments to this spec's option
* @return self, so that the caller can add clauses to the fluent interface sentence
* @throws NullPointerException if the type is {@code null}
* @throws IllegalArgumentException if the type does not have the standard conversion
* methods
*/
public final ArgumentAcceptingOptionSpec ofType( Class argumentType ) {
return withValuesConvertedBy( findConverter( argumentType ) );
}
/**
* Specifies a converter to use to translate arguments of this spec's option into
* Java objects. This is useful when converting to types that do not have the
* requisite factory method or constructor for {@link #ofType(Class)}.
*
* Invoking this method will trump any previous calls to this method or to
* {@link #ofType(Class)}.
*
* @param represents the runtime class of the desired option argument type
* @param aConverter the converter to use
* @return self, so that the caller can add clauses to the fluent interface sentence
* @throws NullPointerException if the converter is {@code null}
*/
@SuppressWarnings( "unchecked" )
public final ArgumentAcceptingOptionSpec withValuesConvertedBy( ValueConverter aConverter ) {
if ( aConverter == null )
throw new NullPointerException( "illegal null converter" );
converter = (ValueConverter) aConverter;
return (ArgumentAcceptingOptionSpec) this;
}
/**
* Specifies a description for the argument of the option that this spec
* represents. This description is used when generating help information about
* the parser.
*
* @param description describes the nature of the argument of this spec's
* option
* @return self, so that the caller can add clauses to the fluent interface sentence
*/
public final ArgumentAcceptingOptionSpec describedAs( String description ) {
argumentDescription = description;
return this;
}
/**
* Specifies a value separator for the argument of the option that this spec
* represents. This allows a single option argument to represent multiple values
* for the option. For example:
*
*
*
* parser.accepts( "z" ).withRequiredArg()
* .withValuesSeparatedBy( ',' );
* OptionSet options = parser.parse( new String[] { "-z", "foo,bar,baz", "-z",
* "fizz", "-z", "buzz" } );
*
*
*
* Then {@code options.valuesOf( "z" )} would yield the list {@code [foo, bar,
* baz, fizz, buzz]}.
*
* You cannot use Unicode U+0000 as the separator.
*
* @param separator a character separator
* @return self, so that the caller can add clauses to the fluent interface sentence
* @throws IllegalArgumentException if the separator is Unicode U+0000
*/
public final ArgumentAcceptingOptionSpec withValuesSeparatedBy( char separator ) {
if ( separator == NIL_VALUE_SEPARATOR )
throw new IllegalArgumentException( "cannot use U+0000 as separator" );
valueSeparator = String.valueOf( separator );
return this;
}
/**
* Specifies a set of default values for the argument of the option that this spec
* represents.
*
* @param value the first in the set of default argument values for this spec's option
* @param values the (optional) remainder of the set of default argument values for this spec's option
* @return self, so that the caller can add clauses to the fluent interface sentence
* @throws NullPointerException if {@code value}, {@code values}, or any elements of {@code values} are
* {@code null}
*/
public ArgumentAcceptingOptionSpec defaultsTo( V value, V... values ) {
addDefaultValue( value );
for ( V each : values )
addDefaultValue( each );
return this;
}
private void addDefaultValue( V value ) {
ensureNotNull( value );
defaultValues.add( value );
}
@Override
final void handleOption( OptionParser parser, ArgumentList arguments, OptionSet detectedOptions,
String detectedArgument ) {
if ( isNullOrEmpty( detectedArgument ) )
detectOptionArgument( parser, arguments, detectedOptions );
else
addArguments( detectedOptions, detectedArgument );
}
protected void addArguments( OptionSet detectedOptions, String detectedArgument ) {
StringTokenizer lexer = new StringTokenizer( detectedArgument, valueSeparator );
if ( !lexer.hasMoreTokens() )
detectedOptions.addWithArgument( this, detectedArgument );
else {
while ( lexer.hasMoreTokens() )
detectedOptions.addWithArgument( this, lexer.nextToken() );
}
}
protected abstract void detectOptionArgument( OptionParser parser, ArgumentList arguments,
OptionSet detectedOptions );
@SuppressWarnings( "unchecked" )
@Override
protected final V convert( String argument ) {
if ( converter == null )
return (V) argument;
try {
return converter.convert( argument );
}
catch ( ReflectionException ex ) {
throw new OptionArgumentConversionException( options(), argument, converter.valueType(), ex );
}
catch ( ValueConversionException ex ) {
throw new OptionArgumentConversionException( options(), argument, converter.valueType(), ex );
}
}
protected boolean canConvertArgument( String argument ) {
StringTokenizer lexer = new StringTokenizer( argument, valueSeparator );
try {
while ( lexer.hasMoreTokens() )
convert( lexer.nextToken() );
return true;
}
catch ( OptionException ignored ) {
return false;
}
}
protected boolean isArgumentOfNumberType() {
return converter != null && Number.class.isAssignableFrom( converter.valueType() );
}
@Override
boolean acceptsArguments() {
return true;
}
@Override
boolean requiresArgument() {
return argumentRequired;
}
String argumentDescription() {
return argumentDescription;
}
String typeIndicator() {
if ( converter == null )
return null;
String pattern = converter.valuePattern();
return pattern == null ? converter.valueType().getName() : pattern;
}
@Override
List defaultValues() {
return unmodifiableList( defaultValues );
}
@Override
public boolean equals( Object that ) {
if ( !super.equals( that ) )
return false;
ArgumentAcceptingOptionSpec other = (ArgumentAcceptingOptionSpec) that;
return requiresArgument() == other.requiresArgument();
}
@Override
public int hashCode() {
return super.hashCode() ^ ( argumentRequired ? 0 : 1 );
}
}