<!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>org.apache.commons.cli (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="org.apache.commons.cli (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><a href="package-use.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li>Prev Package</li> <li>Next Package</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/commons/cli/package-summary.html" target="_top">Frames</a></li> <li><a href="package-summary.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="header"> <h1 title="Package" class="title">Package org.apache.commons.cli</h1> <div class="docSummary"> <div class="block">Commons CLI 1.3</div> </div> <p>See: <a href="#package.description">Description</a></p> </div> <div class="contentContainer"> <ul class="blockList"> <li class="blockList"> <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Interface</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/CommandLineParser.html" title="interface in org.apache.commons.cli">CommandLineParser</a></td> <td class="colLast"> <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> </td> </tr> </tbody> </table> </li> <li class="blockList"> <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Class</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/BasicParser.html" title="class in org.apache.commons.cli">BasicParser</a></td> <td class="colLast">Deprecated <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> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/CommandLine.html" title="class in org.apache.commons.cli">CommandLine</a></td> <td class="colLast"> <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> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/CommandLine.Builder.html" title="class in org.apache.commons.cli">CommandLine.Builder</a></td> <td class="colLast"> <div class="block">A nested builder class to create <code>CommandLine</code> instance using descriptive methods.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/DefaultParser.html" title="class in org.apache.commons.cli">DefaultParser</a></td> <td class="colLast"> <div class="block">Default parser.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/GnuParser.html" title="class in org.apache.commons.cli">GnuParser</a></td> <td class="colLast">Deprecated <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> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/HelpFormatter.html" title="class in org.apache.commons.cli">HelpFormatter</a></td> <td class="colLast"> <div class="block">A formatter of help messages for command line options.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/Option.html" title="class in org.apache.commons.cli">Option</a></td> <td class="colLast"> <div class="block">Describes a single command-line option.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/Option.Builder.html" title="class in org.apache.commons.cli">Option.Builder</a></td> <td class="colLast"> <div class="block">A nested builder class to create <code>Option</code> instances using descriptive methods.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/OptionBuilder.html" title="class in org.apache.commons.cli">OptionBuilder</a></td> <td class="colLast">Deprecated <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> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/OptionGroup.html" title="class in org.apache.commons.cli">OptionGroup</a></td> <td class="colLast"> <div class="block">A group of mutually exclusive options.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/Options.html" title="class in org.apache.commons.cli">Options</a></td> <td class="colLast"> <div class="block">Main entry-point into the library.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/Parser.html" title="class in org.apache.commons.cli">Parser</a></td> <td class="colLast">Deprecated <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> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/PatternOptionBuilder.html" title="class in org.apache.commons.cli">PatternOptionBuilder</a></td> <td class="colLast"> <div class="block">Allows Options to be created from a single String.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/PosixParser.html" title="class in org.apache.commons.cli">PosixParser</a></td> <td class="colLast">Deprecated <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> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/TypeHandler.html" title="class in org.apache.commons.cli">TypeHandler</a></td> <td class="colLast"> <div class="block">This is a temporary implementation.</div> </td> </tr> </tbody> </table> </li> <li class="blockList"> <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Exception</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/AlreadySelectedException.html" title="class in org.apache.commons.cli">AlreadySelectedException</a></td> <td class="colLast"> <div class="block">Thrown when more than one option in an option group has been provided.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/AmbiguousOptionException.html" title="class in org.apache.commons.cli">AmbiguousOptionException</a></td> <td class="colLast"> <div class="block">Exception thrown when an option can't be identified from a partial name.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/MissingArgumentException.html" title="class in org.apache.commons.cli">MissingArgumentException</a></td> <td class="colLast"> <div class="block">Thrown when an option requiring an argument is not provided with an argument.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/MissingOptionException.html" title="class in org.apache.commons.cli">MissingOptionException</a></td> <td class="colLast"> <div class="block">Thrown when a required option has not been provided.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/ParseException.html" title="class in org.apache.commons.cli">ParseException</a></td> <td class="colLast"> <div class="block">Base for Exceptions thrown during parsing of a command-line.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/commons/cli/UnrecognizedOptionException.html" title="class in org.apache.commons.cli">UnrecognizedOptionException</a></td> <td class="colLast"> <div class="block">Exception thrown during parsing signalling an unrecognized option was seen.</div> </td> </tr> </tbody> </table> </li> </ul> <a name="package.description"> <!-- --> </a> <h2 title="Package org.apache.commons.cli Description">Package org.apache.commons.cli Description</h2> <div class="block">Commons CLI 1.3</div> <dl> <dt><span class="simpleTagLabel">Version:</span></dt> <dd>$Id: package-info.java 1443102 2013-02-06 18:12:16Z tn $</dd> </dl> </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><a href="package-use.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li>Prev Package</li> <li>Next Package</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/commons/cli/package-summary.html" target="_top">Frames</a></li> <li><a href="package-summary.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>