| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_144) on Sun May 10 12:47:48 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Uses of Class org.apache.logging.log4j.core.tools.picocli.CommandLine (Apache Log4j Core 2.13.3 API)</title> |
| <meta name="date" content="2020-05-10"> |
| <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="Uses of Class org.apache.logging.log4j.core.tools.picocli.CommandLine (Apache Log4j Core 2.13.3 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="../../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="../package-summary.html">Package</a></li> |
| <li><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">Class</a></li> |
| <li class="navBarCell1Rev">Use</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</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.html" target="_top">Frames</a></li> |
| <li><a href="CommandLine.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"> |
| <h2 title="Uses of Class org.apache.logging.log4j.core.tools.picocli.CommandLine" class="title">Uses of Class<br>org.apache.logging.log4j.core.tools.picocli.CommandLine</h2> |
| </div> |
| <div class="classUseContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> |
| <caption><span>Packages that use <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Package</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="#org.apache.logging.log4j.core.tools.picocli">org.apache.logging.log4j.core.tools.picocli</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <ul class="blockList"> |
| <li class="blockList"><a name="org.apache.logging.log4j.core.tools.picocli"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> in <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/package-summary.html">org.apache.logging.log4j.core.tools.picocli</a></h3> |
| <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> |
| <caption><span>Methods in <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/package-summary.html">org.apache.logging.log4j.core.tools.picocli</a> that return <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#addSubcommand-java.lang.String-java.lang.Object-">addSubcommand</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> command)</code> |
| <div class="block">Registers a subcommand with the specified name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.ExecutionException.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.ExecutionException.html#getCommandLine--">getCommandLine</a></span>()</code> |
| <div class="block">Returns the <code>CommandLine</code> object for the (sub)command that could not be invoked.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.ParameterException.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.ParameterException.html#getCommandLine--">getCommandLine</a></span>()</code> |
| <div class="block">Returns the <code>CommandLine</code> object for the (sub)command whose input could not be parsed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#getParent--">getParent</a></span>()</code> |
| <div class="block">Returns the command that this is a subcommand of, or <code>null</code> if this is a top-level command.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><K> <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#registerConverter-java.lang.Class-org.apache.logging.log4j.core.tools.picocli.CommandLine.ITypeConverter-">registerConverter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><K> cls, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.ITypeConverter.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.ITypeConverter</a><K> converter)</code> |
| <div class="block">Registers the specified type converter for the specified class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#setCommandName-java.lang.String-">setCommandName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> commandName)</code> |
| <div class="block">Sets the command name (also called program name) displayed in the usage help synopsis to the specified value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#setOverwrittenOptionsAllowed-boolean-">setOverwrittenOptionsAllowed</a></span>(boolean newValue)</code> |
| <div class="block">Sets whether options for single-value fields can be specified multiple times on the command line without a <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.OverwrittenOptionException.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.OverwrittenOptionException</code></a> being thrown.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#setSeparator-java.lang.String-">setSeparator</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> separator)</code> |
| <div class="block">Sets the String the parser uses to separate option names from option values to the specified value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#setUnmatchedArgumentsAllowed-boolean-">setUnmatchedArgumentsAllowed</a></span>(boolean newValue)</code> |
| <div class="block">Sets whether the end user may specify unmatched arguments on the command line without a <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.UnmatchedArgumentException.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.UnmatchedArgumentException</code></a> being thrown.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> |
| <caption><span>Methods in <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/package-summary.html">org.apache.logging.log4j.core.tools.picocli</a> that return types with arguments of type <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a>></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#getSubcommands--">getSubcommands</a></span>()</code> |
| <div class="block">Returns a map with the subcommands <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#addSubcommand-java.lang.String-java.lang.Object-">registered</a> on this instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a>></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#parse-java.lang.String...-">parse</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</code> |
| <div class="block">Parses the specified command line arguments and returns a list of <code>CommandLine</code> objects representing the |
| top-level command and any subcommands (if any) that were recognized and initialized during the parsing process.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> |
| <caption><span>Method parameters in <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/package-summary.html">org.apache.logging.log4j.core.tools.picocli</a> with type arguments of type <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.Help.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#addAllSubcommands-java.util.Map-">addAllSubcommands</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a>> commands)</code> |
| <div class="block">Registers all specified subcommands with this Help.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.IParseResultHandler.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.IParseResultHandler.html#handleParseResult-java.util.List-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a>> parsedCommands, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> out, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a> ansi)</code> |
| <div class="block">Processes a List of <code>CommandLine</code> objects resulting from successfully |
| <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#parse-java.lang.String...-">parsing</a> the command line arguments and optionally returns a list of results.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.RunFirst.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.RunFirst.html#handleParseResult-java.util.List-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a>> parsedCommands, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> out, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a> ansi)</code> |
| <div class="block">Prints help if requested, and otherwise executes the top-level <code>Runnable</code> or <code>Callable</code> command.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.RunLast.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.RunLast.html#handleParseResult-java.util.List-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a>> parsedCommands, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> out, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a> ansi)</code> |
| <div class="block">Prints help if requested, and otherwise executes the most specific <code>Runnable</code> or <code>Callable</code> subcommand.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.RunAll.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.RunAll.html#handleParseResult-java.util.List-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">handleParseResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a>> parsedCommands, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> out, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a> ansi)</code> |
| <div class="block">Prints help if requested, and otherwise executes the top-level command and all subcommands as <code>Runnable</code> |
| or <code>Callable</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#printHelpIfRequested-java.util.List-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">printHelpIfRequested</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a>> parsedCommands, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a> out, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a> ansi)</code> |
| <div class="block">Helper method that may be useful when processing the list of <code>CommandLine</code> objects that result from successfully |
| <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#parse-java.lang.String...-">parsing</a> command line arguments.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> |
| <caption><span>Constructors in <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/package-summary.html">org.apache.logging.log4j.core.tools.picocli</a> with parameters of type <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.ExecutionException.html#ExecutionException-org.apache.logging.log4j.core.tools.picocli.CommandLine-java.lang.String-">ExecutionException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> commandLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.ExecutionException.html#ExecutionException-org.apache.logging.log4j.core.tools.picocli.CommandLine-java.lang.String-java.lang.Exception-">ExecutionException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> commandLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a> ex)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.MaxValuesforFieldExceededException.html#MaxValuesforFieldExceededException-org.apache.logging.log4j.core.tools.picocli.CommandLine-java.lang.String-">MaxValuesforFieldExceededException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> commandLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.MissingParameterException.html#MissingParameterException-org.apache.logging.log4j.core.tools.picocli.CommandLine-java.lang.String-">MissingParameterException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> commandLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.MissingTypeConverterException.html#MissingTypeConverterException-org.apache.logging.log4j.core.tools.picocli.CommandLine-java.lang.String-">MissingTypeConverterException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> commandLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.OverwrittenOptionException.html#OverwrittenOptionException-org.apache.logging.log4j.core.tools.picocli.CommandLine-java.lang.String-">OverwrittenOptionException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> commandLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.ParameterException.html#ParameterException-org.apache.logging.log4j.core.tools.picocli.CommandLine-java.lang.String-">ParameterException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> commandLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg)</code> |
| <div class="block">Constructs a new ParameterException with the specified CommandLine and error message.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.ParameterException.html#ParameterException-org.apache.logging.log4j.core.tools.picocli.CommandLine-java.lang.String-java.lang.Exception-">ParameterException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> commandLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a> ex)</code> |
| <div class="block">Constructs a new ParameterException with the specified CommandLine and error message.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.UnmatchedArgumentException.html#UnmatchedArgumentException-org.apache.logging.log4j.core.tools.picocli.CommandLine-java.util.List-">UnmatchedArgumentException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> commandLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.UnmatchedArgumentException.html#UnmatchedArgumentException-org.apache.logging.log4j.core.tools.picocli.CommandLine-java.util.Stack-">UnmatchedArgumentException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> commandLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.UnmatchedArgumentException.html#UnmatchedArgumentException-org.apache.logging.log4j.core.tools.picocli.CommandLine-java.lang.String-">UnmatchedArgumentException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a> commandLine, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg)</code> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </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="../../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="../package-summary.html">Package</a></li> |
| <li><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">Class</a></li> |
| <li class="navBarCell1Rev">Use</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</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.html" target="_top">Frames</a></li> |
| <li><a href="CommandLine.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><p align="center">Copyright © 1999-2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p> |
| </body> |
| </html> |