public class MultiArgument extends java.lang.Object implements CommandlineFragment
A multiple argument commandline fragment that greedily consumes what's left on the commandline as arguments.
COMMAND_PREFIX
Constructor and Description |
---|
MultiArgument(java.lang.String argName,
java.lang.String description,
boolean optional) |
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> |
consume(java.util.List<java.lang.String> s)
Grab the pieces of the commandline relevant to this argument, configure the
implementation, and then return a new array of arguments that will have the
pieces of the original commandline that this command used removed.
|
java.lang.String |
getDescription()
Return a description of this commandline fragment.
|
java.lang.String |
getUsage()
Construct a usage string for this commandline fragment.
|
java.lang.String[] |
getValues() |
boolean |
isOptional() |
boolean |
isSet() |
void |
reset()
Reset the fragment to its initial state.
|
public MultiArgument(java.lang.String argName, java.lang.String description, boolean optional)
public void reset()
CommandlineFragment
Reset the fragment to its initial state. This is useful for reusing fragments in multiple commandline structures.
reset
in interface CommandlineFragment
public java.util.List<java.lang.String> consume(java.util.List<java.lang.String> s) throws CommandlineSyntaxException
CommandlineFragment
Grab the pieces of the commandline relevant to this argument, configure the implementation, and then return a new array of arguments that will have the pieces of the original commandline that this command used removed.
consume
in interface CommandlineFragment
s
- the list of argumentsCommandlineSyntaxException
- if the commandline is structurally invalid.public boolean isOptional()
isOptional
in interface CommandlineFragment
true
if this fragment is optional.public boolean isSet()
public java.lang.String[] getValues()
public java.lang.String getUsage()
CommandlineFragment
Construct a usage string for this commandline fragment. The usage string is used when constructing a strawman commandline example and when formatting help.
getUsage
in interface CommandlineFragment
public java.lang.String getDescription()
CommandlineFragment
Return a description of this commandline fragment. The description should be a (short) narrative item that describes the purpose of the fragment. It is only used when formatting help.
getDescription
in interface CommandlineFragment