org.kohsuke.args4j.opts
Class StringOption
java.lang.Object
org.kohsuke.args4j.opts.StringOption
- All Implemented Interfaces:
- CmdLineOption
- Direct Known Subclasses:
- OutputStreamOption
public class StringOption
- extends java.lang.Object
- implements CmdLineOption
Option that takes a String
as a parameter.
For example, you can parse "-mode RELEASE" or
"-mode DEBUG" into "RELEASE"/"DEBUG".
- Author:
- Kohsuke Kawaguchi (kk@kohsuke.org)
Field Summary |
java.lang.String |
value
Value of this option. |
Constructor Summary |
StringOption(java.lang.String optionName)
|
StringOption(java.lang.String optionName,
java.lang.String defaultValue)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
value
public java.lang.String value
- Value of this option.
StringOption
public StringOption(java.lang.String optionName)
StringOption
public StringOption(java.lang.String optionName,
java.lang.String defaultValue)
accepts
public boolean accepts(java.lang.String optionName)
- Description copied from interface:
CmdLineOption
- Checks if this option parser recognizes the specified
option name.
- Specified by:
accepts
in interface CmdLineOption
parseArguments
public int parseArguments(CmdLineParser parser,
CmdLineOption.Parameters params)
throws CmdLineException
- Description copied from interface:
CmdLineOption
- Called if the option that this parser recognizes is found.
- Specified by:
parseArguments
in interface CmdLineOption
- Parameters:
parser
- The parser that's using this option object.
For example, if the option "-quiet" is simply an alias to
"-verbose 5", then the implementation can just call the
CmdLineParser.parse(String[])
method recursively.params
- The rest of the arguments. This method can use this
object to access the arguments of the option if necessary.
- Returns:
- The number of arguments consumed. For example, return 0
if this option doesn't take any parameter.
- Throws:
CmdLineException
Copyright © 2003-2011 Kohsuke Kawaguchi. All Rights Reserved.