Package org.kohsuke.args4j.spi
Interface Parameters
- All Known Implementing Classes:
CmdLineParser.CmdLineImpl
public interface Parameters
List of arguments.
Object of this interface is passed to
OptionHandler
s to make it easy/safe to parse
additional parameters for options.
-
Method Summary
Modifier and TypeMethodDescriptiongetParameter
(int idx) Gets the additional parameter to this option.int
size()
Number of remaining tokens.
-
Method Details
-
getParameter
Gets the additional parameter to this option.- Parameters:
idx
- specifying 0 will retrieve the token next to the option. For example, if the command line looks like-o abc -d x
, thengetParameter(0)
for-o
returnsabc
andgetParameter(1)
will return-d
.- Returns:
- Always return non-
null
validString
. If an attempt is made to access a non-existent index, this method throws appropriateCmdLineException
. - Throws:
CmdLineException
-
size
int size()Number of remaining tokens.
-