|
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="de">
- <head>
- <!-- Generated by javadoc -->
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <title>Index (Apache Commons CLI 1.4 API)</title>
- <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
- <script type="text/javascript" src="script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Index (Apache Commons CLI 1.4 API)";
- }
- }
- catch(err) {
- }
- //-->
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="org/apache/commons/cli/package-summary.html">Package</a></li>
- <li>Class</li>
- <li>Use</li>
- <li><a href="org/apache/commons/cli/package-tree.html">Tree</a></li>
- <li><a href="deprecated-list.html">Deprecated</a></li>
- <li class="navBarCell1Rev">Index</li>
- <li><a href="help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li>Prev</li>
- <li>Next</li>
- </ul>
- <ul class="navList">
- <li><a href="index.html?index-all.html" target="_top">Frames</a></li>
- <li><a href="index-all.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <div class="contentContainer"><a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> <a name="I:A">
- <!-- -->
- </a>
- <h2 class="title">A</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#addArg-java.lang.String-">addArg(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Add left-over unrecognized option/argument.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.Builder.html#addArg-java.lang.String-">addArg(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a></dt>
- <dd>
- <div class="block">Add left-over unrecognized option/argument.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#addOption-org.apache.commons.cli.Option-">addOption(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Add an option to the command line.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.Builder.html#addOption-org.apache.commons.cli.Option-">addOption(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a></dt>
- <dd>
- <div class="block">Add an option to the command line.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#addOption-org.apache.commons.cli.Option-">addOption(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
- <dd>
- <div class="block">Add the specified <code>Option</code> to this group.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addOption-java.lang.String-java.lang.String-">addOption(String, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Add an option that only contains a short name.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addOption-java.lang.String-boolean-java.lang.String-">addOption(String, boolean, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Add an option that only contains a short-name.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addOption-java.lang.String-java.lang.String-boolean-java.lang.String-">addOption(String, String, boolean, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Add an option that contains a short-name and a long-name.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addOption-org.apache.commons.cli.Option-">addOption(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Adds an option instance</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addOptionGroup-org.apache.commons.cli.OptionGroup-">addOptionGroup(OptionGroup)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Add the specified option group.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#addRequiredOption-java.lang.String-java.lang.String-boolean-java.lang.String-">addRequiredOption(String, String, boolean, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Add an option that contains a short-name and a long-name.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#addValue-java.lang.String-">addValue(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
- </dd>
- <dt><a href="org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">AlreadySelectedException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">Thrown when more than one option in an option group
- has been provided.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AlreadySelectedException.html#AlreadySelectedException-java.lang.String-">AlreadySelectedException(String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli">AlreadySelectedException</a></dt>
- <dd>
- <div class="block">Construct a new <code>AlreadySelectedException</code>
- with the specified detail message.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AlreadySelectedException.html#AlreadySelectedException-org.apache.commons.cli.OptionGroup-org.apache.commons.cli.Option-">AlreadySelectedException(OptionGroup, Option)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli">AlreadySelectedException</a></dt>
- <dd>
- <div class="block">Construct a new <code>AlreadySelectedException</code>
- for the specified option group.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/AmbiguousOptionException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">AmbiguousOptionException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">Exception thrown when an option can't be identified from a partial name.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AmbiguousOptionException.html#AmbiguousOptionException-java.lang.String-java.util.Collection-">AmbiguousOptionException(String, Collection<String>)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/AmbiguousOptionException.html" title="class in org.apache.commons.cli">AmbiguousOptionException</a></dt>
- <dd>
- <div class="block">Constructs a new AmbiguousOptionException.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#argName-java.lang.String-">argName(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Sets the display name for the argument value.</div>
- </dd>
- </dl>
- <a name="I:B">
- <!-- -->
- </a>
- <h2 class="title">B</h2>
- <dl>
- <dt><a href="org/apache/commons/cli/BasicParser.html" title="class in org.apache.commons.cli"><span class="typeNameLink">BasicParser</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">since 1.3, use the <a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli"><code>DefaultParser</code></a> instead</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/BasicParser.html#BasicParser--">BasicParser()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/BasicParser.html" title="class in org.apache.commons.cli">BasicParser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.Builder.html#build--">build()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#build--">build()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Constructs an Option with the values declared by this <a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.Builder.html#Builder--">Builder()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#builder--">builder()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Returns a <a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> to create an <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> using descriptive
- methods.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#builder-java.lang.String-">builder(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Returns a <a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><code>Option.Builder</code></a> to create an <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> using descriptive
- methods.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PosixParser.html#burstToken-java.lang.String-boolean-">burstToken(String, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/PosixParser.html" title="class in org.apache.commons.cli">PosixParser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Breaks <code>token</code> into its constituent parts
- using the following algorithm.</div>
- </dd>
- </dl>
- <a name="I:C">
- <!-- -->
- </a>
- <h2 class="title">C</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#checkRequiredOptions--">checkRequiredOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Throws a <a href="org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli"><code>MissingOptionException</code></a> if all of the required options
- are not present.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#CLASS_VALUE">CLASS_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">Class class</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#clone--">clone()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">A rather odd clone method - due to incorrect code in 1.0 it is public
- and in 1.1 rather than throwing a CloneNotSupportedException it throws
- a RuntimeException so as to maintain backwards compat at the API level.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#cmd">cmd</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd>
- <div class="block">The command-line instance.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#cmd">cmd</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">commandline instance</div>
- </dd>
- <dt><a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli"><span class="typeNameLink">CommandLine</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">Represents list of arguments parsed against a <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a> descriptor.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#CommandLine--">CommandLine()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Creates a command line.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">CommandLine.Builder</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">A nested builder class to create <code>CommandLine</code> instance
- using descriptive methods.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/CommandLineParser.html" title="interface in org.apache.commons.cli"><span class="typeNameLink">CommandLineParser</span></a> - Interface in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">A class that implements the <code>CommandLineParser</code> interface
- can parse a String array according to the <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a> specified
- and return a <a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli"><code>CommandLine</code></a>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#create-char-">create(char)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Create an Option using the current settings and with
- the specified Option <code>char</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#create--">create()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Create an Option using the current settings</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#create-java.lang.String-">create(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Create an Option using the current settings and with
- the specified Option <code>char</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createClass-java.lang.String-">createClass(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
- <dd>
- <div class="block">Returns the class whose name is <code>classname</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createDate-java.lang.String-">createDate(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
- <dd>
- <div class="block">Returns the date represented by <code>str</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createFile-java.lang.String-">createFile(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
- <dd>
- <div class="block">Returns the File represented by <code>str</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createFiles-java.lang.String-">createFiles(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
- <dd>
- <div class="block">Returns the File[] represented by <code>str</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createNumber-java.lang.String-">createNumber(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
- <dd>
- <div class="block">Create a number from a String.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createObject-java.lang.String-">createObject(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
- <dd>
- <div class="block">Create an Object from the classname and empty constructor.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#createPadding-int-">createPadding(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Return a String of padding of length <code>len</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createURL-java.lang.String-">createURL(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
- <dd>
- <div class="block">Returns the URL represented by <code>str</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createValue-java.lang.String-java.lang.Object-">createValue(String, Object)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
- <dd>
- <div class="block">Returns the <code>Object</code> of type <code>obj</code>
- with the value of <code>str</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#createValue-java.lang.String-java.lang.Class-">createValue(String, Class<?>)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
- <dd>
- <div class="block">Returns the <code>Object</code> of type <code>clazz</code>
- with the value of <code>str</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#currentOption">currentOption</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd>
- <div class="block">The last option parsed.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#currentToken">currentToken</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd>
- <div class="block">The token currently processed.</div>
- </dd>
- </dl>
- <a name="I:D">
- <!-- -->
- </a>
- <h2 class="title">D</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#DATE_VALUE">DATE_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">Date class</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_ARG_NAME">DEFAULT_ARG_NAME</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">default name for an argument</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_DESC_PAD">DEFAULT_DESC_PAD</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">number of space characters to be prefixed to each description line</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_LEFT_PAD">DEFAULT_LEFT_PAD</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">default padding to the left of each line</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_LONG_OPT_PREFIX">DEFAULT_LONG_OPT_PREFIX</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">default prefix for long Option</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_LONG_OPT_SEPARATOR">DEFAULT_LONG_OPT_SEPARATOR</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">default separator displayed between a long Option and its value</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_OPT_PREFIX">DEFAULT_OPT_PREFIX</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">default prefix for shortOpts</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_SYNTAX_PREFIX">DEFAULT_SYNTAX_PREFIX</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">the string to display at the beginning of the usage statement</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#DEFAULT_WIDTH">DEFAULT_WIDTH</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">default number of characters per line</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultArgName">defaultArgName</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">Scope will be made private for next major version
- - use get/setArgName methods instead.</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultDescPad">defaultDescPad</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">Scope will be made private for next major version
- - use get/setDescPadding methods instead.</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultLeftPad">defaultLeftPad</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">Scope will be made private for next major version
- - use get/setLeftPadding methods instead.</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultLongOptPrefix">defaultLongOptPrefix</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">Scope will be made private for next major version
- - use get/setLongOptPrefix methods instead.</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultNewLine">defaultNewLine</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">Scope will be made private for next major version
- - use get/setNewLine methods instead.</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultOptPrefix">defaultOptPrefix</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">Scope will be made private for next major version
- - use get/setOptPrefix methods instead.</span></div>
- </div>
- </dd>
- <dt><a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli"><span class="typeNameLink">DefaultParser</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">Default parser.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#DefaultParser--">DefaultParser()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultSyntaxPrefix">defaultSyntaxPrefix</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">Scope will be made private for next major version
- - use get/setSyntaxPrefix methods instead.</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#defaultWidth">defaultWidth</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">Scope will be made private for next major version
- - use get/setWidth methods instead.</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#desc-java.lang.String-">desc(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Sets the description for this option.</div>
- </dd>
- </dl>
- <a name="I:E">
- <!-- -->
- </a>
- <h2 class="title">E</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#EXISTING_FILE_VALUE">EXISTING_FILE_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">FileInputStream class</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#expectedOpts">expectedOpts</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd>
- <div class="block">The required options and groups expected to be found when parsing the command line.</div>
- </dd>
- </dl>
- <a name="I:F">
- <!-- -->
- </a>
- <h2 class="title">F</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#FILE_VALUE">FILE_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">File class</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#FILES_VALUE">FILES_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">File array class</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#findWrapPos-java.lang.String-int-int-">findWrapPos(String, int, int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Finds the next text wrap position after <code>startPos</code> for the
- text in <code>text</code> with the column width <code>width</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/BasicParser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-">flatten(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/BasicParser.html" title="class in org.apache.commons.cli">BasicParser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">A simple implementation of <a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli"><code>Parser</code></a>'s abstract
- <a href="org/apache/commons/cli/Parser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-"><code>flatten</code></a> method.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/GnuParser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-">flatten(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/GnuParser.html" title="class in org.apache.commons.cli">GnuParser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">This flatten method does so using the following rules:
-
- If an <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> exists for the first character of
- the <code>arguments</code> entry <b>AND</b> an <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a>
- does not exist for the whole <code>argument</code> then
- add the first character as an option to the processed tokens
- list e.g.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-">flatten(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Subclasses must implement this method to reduce
- the <code>arguments</code> that have been passed to the parse method.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PosixParser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-">flatten(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/PosixParser.html" title="class in org.apache.commons.cli">PosixParser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">An implementation of <a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli"><code>Parser</code></a>'s abstract
- <a href="org/apache/commons/cli/Parser.html#flatten-org.apache.commons.cli.Options-java.lang.String:A-boolean-"><code>flatten</code></a> method.</div>
- </dd>
- </dl>
- <a name="I:G">
- <!-- -->
- </a>
- <h2 class="title">G</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getArgList--">getArgList()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Retrieve any left-over non-recognized options and arguments</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getArgName--">getArgName()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Returns the 'argName'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getArgName--">getArgName()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Gets the display name for the argument value.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getArgs--">getArgs()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Retrieve any left-over non-recognized options and arguments</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getArgs--">getArgs()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Returns the number of argument values this Option can take.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getDescPadding--">getDescPadding()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Returns the 'descPadding'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getDescription--">getDescription()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Retrieve the self-documenting description of this Option</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getId--">getId()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Returns the id of this Option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getLeftPadding--">getLeftPadding()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Returns the 'leftPadding'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getLongOpt--">getLongOpt()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Retrieve the long name of this Option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getLongOptPrefix--">getLongOptPrefix()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Returns the 'longOptPrefix'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getLongOptSeparator--">getLongOptSeparator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Returns the separator displayed between a long option and its value.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AmbiguousOptionException.html#getMatchingOptions--">getMatchingOptions()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/AmbiguousOptionException.html" title="class in org.apache.commons.cli">AmbiguousOptionException</a></dt>
- <dd>
- <div class="block">Returns the options matching the partial name.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#getMatchingOptions-java.lang.String-">getMatchingOptions(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Returns the options with a long name starting with the name specified.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingOptionException.html#getMissingOptions--">getMissingOptions()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli">MissingOptionException</a></dt>
- <dd>
- <div class="block">Returns the list of options or option groups missing in the command line parsed.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#getNames--">getNames()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getNewLine--">getNewLine()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Returns the 'newLine'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getOpt--">getOpt()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Retrieve the name of this Option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AlreadySelectedException.html#getOption--">getOption()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli">AlreadySelectedException</a></dt>
- <dd>
- <div class="block">Returns the option that was added to the group and triggered the exception.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingArgumentException.html#getOption--">getOption()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingArgumentException.html" title="class in org.apache.commons.cli">MissingArgumentException</a></dt>
- <dd>
- <div class="block">Return the option requiring an argument that wasn't provided
- on the command line.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#getOption-java.lang.String-">getOption(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Retrieve the <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> matching the long or short name specified.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/UnrecognizedOptionException.html#getOption--">getOption()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/UnrecognizedOptionException.html" title="class in org.apache.commons.cli">UnrecognizedOptionException</a></dt>
- <dd>
- <div class="block">Returns the unrecognized option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getOptionComparator--">getOptionComparator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Comparator used to sort the options when they output in help text.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/AlreadySelectedException.html#getOptionGroup--">getOptionGroup()</a></span> - Method in exception org.apache.commons.cli.<a href="org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli">AlreadySelectedException</a></dt>
- <dd>
- <div class="block">Returns the option group where another option has been selected.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#getOptionGroup-org.apache.commons.cli.Option-">getOptionGroup(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Returns the OptionGroup the <code>opt</code> belongs to.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionObject-java.lang.String-">getOptionObject(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">due to System.err message. Instead use getParsedOptionValue(String)</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionObject-char-">getOptionObject(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Return the <code>Object</code> type of this <code>Option</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionProperties-java.lang.String-">getOptionProperties(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Retrieve the map of values associated to the option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptions--">getOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Returns an array of the processed <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a>s.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#getOptions--">getOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#getOptions--">getOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Retrieve a read-only list of options in this set</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#getOptions--">getOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValue-java.lang.String-">getOptionValue(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Retrieve the first argument, if any, of this option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValue-char-">getOptionValue(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Retrieve the first argument, if any, of this option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValue-java.lang.String-java.lang.String-">getOptionValue(String, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Retrieve the first argument, if any, of an option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValue-char-java.lang.String-">getOptionValue(char, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Retrieve the argument, if any, of an option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValues-java.lang.String-">getOptionValues(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Retrieves the array of values, if any, of an option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getOptionValues-char-">getOptionValues(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Retrieves the array of values, if any, of an option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getOptPrefix--">getOptPrefix()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Returns the 'optPrefix'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#getParsedOptionValue-java.lang.String-">getParsedOptionValue(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Return a version of this <code>Option</code> converted to a particular type.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#getRequiredOptions--">getRequiredOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Returns the required options.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#getRequiredOptions--">getRequiredOptions()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#getSelected--">getSelected()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getSyntaxPrefix--">getSyntaxPrefix()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Returns the 'syntaxPrefix'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getType--">getType()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Retrieve the type of this Option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValue--">getValue()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Returns the specified value of this Option or
- <code>null</code> if there is no value.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValue-int-">getValue(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Returns the specified value of this Option or
- <code>null</code> if there is no value.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValue-java.lang.String-">getValue(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Returns the value/first value of this Option or the
- <code>defaultValue</code> if there is no value.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#getValueClass-char-">getValueClass(char)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">Retrieve the class that <code>ch</code> represents.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValues--">getValues()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Return the values of this Option as a String array
- or null if there are no values</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValueSeparator--">getValueSeparator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Returns the value separator character.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#getValuesList--">getValuesList()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#getWidth--">getWidth()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Returns the 'width'.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/GnuParser.html" title="class in org.apache.commons.cli"><span class="typeNameLink">GnuParser</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">since 1.3, use the <a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli"><code>DefaultParser</code></a> instead</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/GnuParser.html#GnuParser--">GnuParser()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/GnuParser.html" title="class in org.apache.commons.cli">GnuParser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- </dd>
- </dl>
- <a name="I:H">
- <!-- -->
- </a>
- <h2 class="title">H</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#handleConcatenatedOptions-java.lang.String-">handleConcatenatedOptions(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd>
- <div class="block">Breaks <code>token</code> into its constituent parts
- using the following algorithm.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#hasArg--">hasArg()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Indicates that the Option will require an argument.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#hasArg-boolean-">hasArg(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Indicates if the Option has an argument or not.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasArg--">hasArg()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Query to see if this Option requires an argument</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasArg--">hasArg()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created will require an argument value.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasArg-boolean-">hasArg(boolean)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created will require an argument value if
- <code>hasArg</code> is true.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasArgName--">hasArgName()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Returns whether the display name for the argument value has been set.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#hasArgs--">hasArgs()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Indicates that the Option can have unlimited argument values.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasArgs--">hasArgs()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Query to see if this Option can take many values.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasArgs--">hasArgs()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created can have unlimited argument values.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasArgs-int-">hasArgs(int)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created can have <code>num</code> argument values.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hashCode--">hashCode()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasLongOpt--">hasLongOpt()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Query to see if this Option has a long name</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#hasLongOption-java.lang.String-">hasLongOption(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Returns whether the named <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#hasOption-java.lang.String-">hasOption(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Query to see if an option has been set.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#hasOption-char-">hasOption(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Query to see if an option has been set.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#hasOption-java.lang.String-">hasOption(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Returns whether the named <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasOptionalArg--">hasOptionalArg()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasOptionalArg--">hasOptionalArg()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option can have an optional argument.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasOptionalArgs--">hasOptionalArgs()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option can have an unlimited number of optional arguments.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#hasOptionalArgs-int-">hasOptionalArgs(int)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option can have the specified number of optional arguments.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#hasShortOption-java.lang.String-">hasShortOption(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Returns whether the named <a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><code>Option</code></a> is a member of this <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#hasValueSeparator--">hasValueSeparator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Return whether this Option has specified a value separator.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli"><span class="typeNameLink">HelpFormatter</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">A formatter of help messages for command line options.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#HelpFormatter--">HelpFormatter()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd> </dd>
- </dl>
- <a name="I:I">
- <!-- -->
- </a>
- <h2 class="title">I</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#isRequired--">isRequired()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Query to see if this Option is mandatory</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#isRequired--">isRequired()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created will be required.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#isRequired-boolean-">isRequired(boolean)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created will be required if <code>required</code>
- is true.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#isRequired--">isRequired()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
- <dd>
- <div class="block">Returns whether this option group is required.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#isValueCode-char-">isValueCode(char)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">Returns whether <code>ch</code> is a value code, i.e.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLine.html#iterator--">iterator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></dt>
- <dd>
- <div class="block">Returns an iterator over the Option members of CommandLine.</div>
- </dd>
- </dl>
- <a name="I:L">
- <!-- -->
- </a>
- <h2 class="title">L</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#longOpt-java.lang.String-">longOpt(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Sets the long name of the Option.</div>
- </dd>
- </dl>
- <a name="I:M">
- <!-- -->
- </a>
- <h2 class="title">M</h2>
- <dl>
- <dt><a href="org/apache/commons/cli/MissingArgumentException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">MissingArgumentException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">Thrown when an option requiring an argument
- is not provided with an argument.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingArgumentException.html#MissingArgumentException-java.lang.String-">MissingArgumentException(String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingArgumentException.html" title="class in org.apache.commons.cli">MissingArgumentException</a></dt>
- <dd>
- <div class="block">Construct a new <code>MissingArgumentException</code>
- with the specified detail message.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingArgumentException.html#MissingArgumentException-org.apache.commons.cli.Option-">MissingArgumentException(Option)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingArgumentException.html" title="class in org.apache.commons.cli">MissingArgumentException</a></dt>
- <dd>
- <div class="block">Construct a new <code>MissingArgumentException</code>
- with the specified detail message.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">MissingOptionException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">Thrown when a required option has not been provided.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingOptionException.html#MissingOptionException-java.lang.String-">MissingOptionException(String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli">MissingOptionException</a></dt>
- <dd>
- <div class="block">Construct a new <code>MissingSelectedException</code>
- with the specified detail message.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/MissingOptionException.html#MissingOptionException-java.util.List-">MissingOptionException(List)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli">MissingOptionException</a></dt>
- <dd>
- <div class="block">Constructs a new <code>MissingSelectedException</code> with the
- specified list of missing options.</div>
- </dd>
- </dl>
- <a name="I:N">
- <!-- -->
- </a>
- <h2 class="title">N</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#NUMBER_VALUE">NUMBER_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">Number class</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#numberOfArgs-int-">numberOfArgs(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Sets the number of argument values the Option can take.</div>
- </dd>
- </dl>
- <a name="I:O">
- <!-- -->
- </a>
- <h2 class="title">O</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#OBJECT_VALUE">OBJECT_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">Object class</div>
- </dd>
- <dt><a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Option</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">Describes a single command-line option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#Option-java.lang.String-java.lang.String-">Option(String, String)</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Creates an Option using the specified parameters.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#Option-java.lang.String-boolean-java.lang.String-">Option(String, boolean, String)</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Creates an Option using the specified parameters.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#Option-java.lang.String-java.lang.String-boolean-java.lang.String-">Option(String, String, boolean, String)</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Creates an Option using the specified parameters.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Option.Builder</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">A nested builder class to create <code>Option</code> instances
- using descriptive methods.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#optionalArg-boolean-">optionalArg(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Sets whether the Option can have an optional argument.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">OptionBuilder</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">since 1.3, use <a href="org/apache/commons/cli/Option.html#builder-java.lang.String-"><code>Option.builder(String)</code></a> instead</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#optionComparator">optionComparator</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Comparator used to sort the options when they output in help text
-
- Defaults to case-insensitive alphabetical sorting by option key</div>
- </dd>
- <dt><a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli"><span class="typeNameLink">OptionGroup</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">A group of mutually exclusive options.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#OptionGroup--">OptionGroup()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#options">options</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd>
- <div class="block">The current options.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Options</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">Main entry-point into the library.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#Options--">Options()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd> </dd>
- <dt><a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a> - package org.apache.commons.cli</dt>
- <dd>
- <div class="block">Commons CLI 1.3</div>
- </dd>
- </dl>
- <a name="I:P">
- <!-- -->
- </a>
- <h2 class="title">P</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLineParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-">parse(Options, String[])</a></span> - Method in interface org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLineParser.html" title="interface in org.apache.commons.cli">CommandLineParser</a></dt>
- <dd>
- <div class="block">Parse the arguments according to the specified options.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/CommandLineParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-boolean-">parse(Options, String[], boolean)</a></span> - Method in interface org.apache.commons.cli.<a href="org/apache/commons/cli/CommandLineParser.html" title="interface in org.apache.commons.cli">CommandLineParser</a></dt>
- <dd>
- <div class="block">Parse the arguments according to the specified options.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-">parse(Options, String[])</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-java.util.Properties-">parse(Options, String[], Properties)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd>
- <div class="block">Parse the arguments according to the specified options and properties.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-boolean-">parse(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-java.util.Properties-boolean-">parse(Options, String[], Properties, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd>
- <div class="block">Parse the arguments according to the specified options and properties.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-">parse(Options, String[])</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Parses the specified <code>arguments</code> based
- on the specified <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-java.util.Properties-">parse(Options, String[], Properties)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Parse the arguments according to the specified options and properties.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-boolean-">parse(Options, String[], boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Parses the specified <code>arguments</code>
- based on the specified <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#parse-org.apache.commons.cli.Options-java.lang.String:A-java.util.Properties-boolean-">parse(Options, String[], Properties, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Parse the arguments according to the specified options and
- properties.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/ParseException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">ParseException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">Base for Exceptions thrown during parsing of a command-line.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/ParseException.html#ParseException-java.lang.String-">ParseException(String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/ParseException.html" title="class in org.apache.commons.cli">ParseException</a></dt>
- <dd>
- <div class="block">Construct a new <code>ParseException</code>
- with the specified detail message.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#parsePattern-java.lang.String-">parsePattern(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">Returns the <a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli"><code>Options</code></a> instance represented by <code>pattern</code>.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli"><span class="typeNameLink">Parser</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">since 1.3, the two-pass parsing with the flatten method is not enough flexible to handle complex cases</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#Parser--">Parser()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- </dd>
- <dt><a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli"><span class="typeNameLink">PatternOptionBuilder</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">Allows Options to be created from a single String.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#PatternOptionBuilder--">PatternOptionBuilder()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd> </dd>
- <dt><a href="org/apache/commons/cli/PosixParser.html" title="class in org.apache.commons.cli"><span class="typeNameLink">PosixParser</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">since 1.3, use the <a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli"><code>DefaultParser</code></a> instead</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PosixParser.html#PosixParser--">PosixParser()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/PosixParser.html" title="class in org.apache.commons.cli">PosixParser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.lang.String-org.apache.commons.cli.Options-">printHelp(String, Options)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the help for <code>options</code> with the specified
- command line syntax.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.lang.String-org.apache.commons.cli.Options-boolean-">printHelp(String, Options, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the help for <code>options</code> with the specified
- command line syntax.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-">printHelp(String, String, Options, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the help for <code>options</code> with the specified
- command line syntax.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-boolean-">printHelp(String, String, Options, String, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the help for <code>options</code> with the specified
- command line syntax.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-">printHelp(int, String, String, Options, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the help for <code>options</code> with the specified
- command line syntax.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-java.lang.String-boolean-">printHelp(int, String, String, Options, String, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the help for <code>options</code> with the specified
- command line syntax.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.io.PrintWriter-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-int-int-java.lang.String-">printHelp(PrintWriter, int, String, String, Options, int, int, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the help for <code>options</code> with the specified
- command line syntax.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printHelp-java.io.PrintWriter-int-java.lang.String-java.lang.String-org.apache.commons.cli.Options-int-int-java.lang.String-boolean-">printHelp(PrintWriter, int, String, String, Options, int, int, String, boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the help for <code>options</code> with the specified
- command line syntax.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printOptions-java.io.PrintWriter-int-org.apache.commons.cli.Options-int-int-">printOptions(PrintWriter, int, Options, int, int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the help for the specified Options to the specified writer,
- using the specified width, left padding and description padding.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printUsage-java.io.PrintWriter-int-java.lang.String-org.apache.commons.cli.Options-">printUsage(PrintWriter, int, String, Options)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Prints the usage statement for the specified application.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printUsage-java.io.PrintWriter-int-java.lang.String-">printUsage(PrintWriter, int, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the cmdLineSyntax to the specified writer, using the
- specified width.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printWrapped-java.io.PrintWriter-int-java.lang.String-">printWrapped(PrintWriter, int, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the specified text to the specified PrintWriter.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#printWrapped-java.io.PrintWriter-int-int-java.lang.String-">printWrapped(PrintWriter, int, int, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Print the specified text to the specified PrintWriter.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#processArgs-org.apache.commons.cli.Option-java.util.ListIterator-">processArgs(Option, ListIterator<String>)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Process the argument values for the specified Option
- <code>opt</code> using the values retrieved from the
- specified iterator <code>iter</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#processOption-java.lang.String-java.util.ListIterator-">processOption(String, ListIterator<String>)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Process the Option specified by <code>arg</code> using the values
- retrieved from the specified iterator <code>iter</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#processProperties-java.util.Properties-">processProperties(Properties)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">Sets the values of Options using the values in <code>properties</code>.</div>
- </dd>
- </dl>
- <a name="I:R">
- <!-- -->
- </a>
- <h2 class="title">R</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#renderOptions-java.lang.StringBuffer-int-org.apache.commons.cli.Options-int-int-">renderOptions(StringBuffer, int, Options, int, int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Render the specified Options and return the rendered Options
- in a StringBuffer.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#renderWrappedText-java.lang.StringBuffer-int-int-java.lang.String-">renderWrappedText(StringBuffer, int, int, String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Render the specified text and return the rendered Options
- in a StringBuffer.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#required--">required()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Marks this Option as required.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#required-boolean-">required(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Sets whether the Option is mandatory.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#rtrim-java.lang.String-">rtrim(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Remove the trailing whitespace from the specified String.</div>
- </dd>
- </dl>
- <a name="I:S">
- <!-- -->
- </a>
- <h2 class="title">S</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setArgName-java.lang.String-">setArgName(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Sets the 'argName'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setArgName-java.lang.String-">setArgName(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Sets the display name for the argument value.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setArgs-int-">setArgs(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Sets the number of argument values this Option can take.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setDescPadding-int-">setDescPadding(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Sets the 'descPadding'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setDescription-java.lang.String-">setDescription(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Sets the self-documenting description of this Option</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setLeftPadding-int-">setLeftPadding(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Sets the 'leftPadding'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setLongOpt-java.lang.String-">setLongOpt(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Sets the long name of this Option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setLongOptPrefix-java.lang.String-">setLongOptPrefix(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Sets the 'longOptPrefix'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setLongOptSeparator-java.lang.String-">setLongOptSeparator(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Set the separator displayed between a long option and its value.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setNewLine-java.lang.String-">setNewLine(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Sets the 'newLine'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setOptionalArg-boolean-">setOptionalArg(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Sets whether this Option can have an optional argument.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setOptionComparator-java.util.Comparator-">setOptionComparator(Comparator<Option>)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Set the comparator used to sort the options when they output in help text.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Parser.html#setOptions-org.apache.commons.cli.Options-">setOptions(Options)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setOptPrefix-java.lang.String-">setOptPrefix(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Sets the 'optPrefix'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setRequired-boolean-">setRequired(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Sets whether this Option is mandatory.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#setRequired-boolean-">setRequired(boolean)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
- <dd> </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#setSelected-org.apache.commons.cli.Option-">setSelected(Option)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
- <dd>
- <div class="block">Set the selected option of this group to <code>name</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setSyntaxPrefix-java.lang.String-">setSyntaxPrefix(String)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Sets the 'syntaxPrefix'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setType-java.lang.Object-">setType(Object)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">since 1.3, use <a href="org/apache/commons/cli/Option.html#setType-java.lang.Class-"><code>Option.setType(Class)</code></a> instead</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setType-java.lang.Class-">setType(Class<?>)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Sets the type of this Option.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#setValueSeparator-char-">setValueSeparator(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Sets the value separator.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/HelpFormatter.html#setWidth-int-">setWidth(int)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></dt>
- <dd>
- <div class="block">Sets the 'width'.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#skipParsing">skipParsing</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd>
- <div class="block">Flag indicating if tokens should no longer be analyzed and simply added as arguments of the command line.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/DefaultParser.html#stopAtNonOption">stopAtNonOption</a></span> - Variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></dt>
- <dd>
- <div class="block">Flag indicating how unrecognized tokens are handled.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#STRING_VALUE">STRING_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">String class</div>
- </dd>
- </dl>
- <a name="I:T">
- <!-- -->
- </a>
- <h2 class="title">T</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#toString--">toString()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">Dump state, suitable for debugging.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionGroup.html#toString--">toString()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></dt>
- <dd>
- <div class="block">Returns the stringified version of this OptionGroup.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Options.html#toString--">toString()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></dt>
- <dd>
- <div class="block">Dump state, suitable for debugging.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#type-java.lang.Class-">type(Class<?>)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">Sets the type of the Option.</div>
- </dd>
- <dt><a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli"><span class="typeNameLink">TypeHandler</span></a> - Class in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">This is a temporary implementation.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/TypeHandler.html#TypeHandler--">TypeHandler()</a></span> - Constructor for class org.apache.commons.cli.<a href="org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></dt>
- <dd> </dd>
- </dl>
- <a name="I:U">
- <!-- -->
- </a>
- <h2 class="title">U</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#UNINITIALIZED">UNINITIALIZED</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">constant that specifies the number of argument values has not been specified</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.html#UNLIMITED_VALUES">UNLIMITED_VALUES</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></dt>
- <dd>
- <div class="block">constant that specifies the number of argument values is infinite</div>
- </dd>
- <dt><a href="org/apache/commons/cli/UnrecognizedOptionException.html" title="class in org.apache.commons.cli"><span class="typeNameLink">UnrecognizedOptionException</span></a> - Exception in <a href="org/apache/commons/cli/package-summary.html">org.apache.commons.cli</a></dt>
- <dd>
- <div class="block">Exception thrown during parsing signalling an unrecognized
- option was seen.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/UnrecognizedOptionException.html#UnrecognizedOptionException-java.lang.String-">UnrecognizedOptionException(String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/UnrecognizedOptionException.html" title="class in org.apache.commons.cli">UnrecognizedOptionException</a></dt>
- <dd>
- <div class="block">Construct a new <code>UnrecognizedArgumentException</code>
- with the specified detail message.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/UnrecognizedOptionException.html#UnrecognizedOptionException-java.lang.String-java.lang.String-">UnrecognizedOptionException(String, String)</a></span> - Constructor for exception org.apache.commons.cli.<a href="org/apache/commons/cli/UnrecognizedOptionException.html" title="class in org.apache.commons.cli">UnrecognizedOptionException</a></dt>
- <dd>
- <div class="block">Construct a new <code>UnrecognizedArgumentException</code>
- with the specified option and detail message.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/PatternOptionBuilder.html#URL_VALUE">URL_VALUE</a></span> - Static variable in class org.apache.commons.cli.<a href="org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></dt>
- <dd>
- <div class="block">URL class</div>
- </dd>
- </dl>
- <a name="I:V">
- <!-- -->
- </a>
- <h2 class="title">V</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#valueSeparator--">valueSeparator()</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">The Option will use '=' as a means to separate argument value.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/Option.Builder.html#valueSeparator-char-">valueSeparator(char)</a></span> - Method in class org.apache.commons.cli.<a href="org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></dt>
- <dd>
- <div class="block">The Option will use <code>sep</code> as a means to
- separate argument values.</div>
- </dd>
- </dl>
- <a name="I:W">
- <!-- -->
- </a>
- <h2 class="title">W</h2>
- <dl>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withArgName-java.lang.String-">withArgName(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created will have the specified argument value name.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withDescription-java.lang.String-">withDescription(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created will have the specified description</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withLongOpt-java.lang.String-">withLongOpt(String)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created will have the following long option value.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Object-">withType(Object)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">since 1.3, use <a href="org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Class-"><code>OptionBuilder.withType(Class)</code></a> instead</span></div>
- </div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withType-java.lang.Class-">withType(Class<?>)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created will have a value that will be an instance
- of <code>type</code>.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withValueSeparator-char-">withValueSeparator(char)</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created uses <code>sep</code> as a means to
- separate argument values.</div>
- </dd>
- <dt><span class="memberNameLink"><a href="org/apache/commons/cli/OptionBuilder.html#withValueSeparator--">withValueSeparator()</a></span> - Static method in class org.apache.commons.cli.<a href="org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></dt>
- <dd>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- <div class="block">The next Option created uses '<code>=</code>' as a means to
- separate argument values.</div>
- </dd>
- </dl>
- <a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> </div>
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="org/apache/commons/cli/package-summary.html">Package</a></li>
- <li>Class</li>
- <li>Use</li>
- <li><a href="org/apache/commons/cli/package-tree.html">Tree</a></li>
- <li><a href="deprecated-list.html">Deprecated</a></li>
- <li class="navBarCell1Rev">Index</li>
- <li><a href="help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li>Prev</li>
- <li>Next</li>
- </ul>
- <ul class="navList">
- <li><a href="index.html?index-all.html" target="_top">Frames</a></li>
- <li><a href="index-all.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <p class="legalCopy"><small>Copyright © 2002–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
- </body>
- </html>
|