| <!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.Help.Ansi (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.Help.Ansi (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.Help.Ansi.html" title="enum 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.Help.Ansi.html" target="_top">Frames</a></li> |
| <li><a href="CommandLine.Help.Ansi.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.Help.Ansi" class="title">Uses of Class<br>org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi</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.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</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.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</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.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</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.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</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#ansi--">ansi</a></span>()</code> |
| <div class="block">Returns whether ANSI escape codes are enabled or not.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.Help.ColorScheme.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.ColorScheme.html#ansi--">ansi</a></span>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.Help.Ansi.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html#valueOf-java.lang.String-">valueOf</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)</code> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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>[]</code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.Help.Ansi.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html#values--">values</a></span>()</code> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</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> with parameters of type <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></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>static <C extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Callable.html?is-external=true" title="class or interface in java.util.concurrent">Callable</a><T>,T><br>T</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#call-C-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-java.lang.String...-">call</a></span>(C callable, |
| <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, |
| <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">Convenience method to allow command line application authors to avoid some boilerplate code in their application.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.ColorScheme.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.ColorScheme</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#defaultColorScheme-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">defaultColorScheme</a></span>(<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">Creates and returns a new <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.ColorScheme.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.ColorScheme</code></a> initialized with picocli default values: commands are bold, |
| options and parameters use a yellow foreground, and option parameters use italic.</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.IExceptionHandler.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.IExceptionHandler.html#handleException-org.apache.logging.log4j.core.tools.picocli.CommandLine.ParameterException-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-java.lang.String...-">handleException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.ParameterException.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.ParameterException</a> ex, |
| <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, |
| <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">Handles a <code>ParameterException</code> that occurred while <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="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.DefaultExceptionHandler.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.DefaultExceptionHandler.html#handleException-org.apache.logging.log4j.core.tools.picocli.CommandLine.ParameterException-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-java.lang.String...-">handleException</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.ParameterException.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.ParameterException</a> ex, |
| <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, |
| <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="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="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.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="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.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="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.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="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</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#join-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-java.lang.String:A-java.lang.StringBuilder-java.lang.Object...-">join</a></span>(<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, |
| <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>[] values, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> sb, |
| <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>... params)</code> |
| <div class="block">Formats each of the specified values and appends it to the specified StringBuilder.</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.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#parseWithHandlers-org.apache.logging.log4j.core.tools.picocli.CommandLine.IParseResultHandler-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-org.apache.logging.log4j.core.tools.picocli.CommandLine.IExceptionHandler-java.lang.String...-">parseWithHandlers</a></span>(<a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.IParseResultHandler.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.IParseResultHandler</a> handler, |
| <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, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.IExceptionHandler.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.IExceptionHandler</a> exceptionHandler, |
| <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">Tries to <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#parse-java.lang.String...-">parse</a> the specified command line arguments, and if successful, delegates |
| the processing of the resulting list of <code>CommandLine</code> objects to the specified <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.IParseResultHandler.html" title="interface in org.apache.logging.log4j.core.tools.picocli">handler</a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</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#printVersionHelp-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">printVersionHelp</a></span>(<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 version information from the <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#version--"><code>CommandLine.Command.version()</code></a> annotation to the specified <code>PrintStream</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</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#printVersionHelp-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-java.lang.Object...-">printVersionHelp</a></span>(<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, |
| <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>... params)</code> |
| <div class="block">Prints version information from the <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#version--"><code>CommandLine.Command.version()</code></a> annotation to the specified <code>PrintStream</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">CommandLine.Help.IParamLabelRenderer.</span><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html#renderParameterLabel-java.lang.reflect.Field-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-java.util.List-">renderParameterLabel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a> field, |
| <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, |
| <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.Help.Ansi.IStyle.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.IStyle</a>> styles)</code> |
| <div class="block">Returns a text rendering of the Option parameter or positional parameter; returns an empty string |
| <code>""</code> if the option is a boolean and does not take a parameter.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <R extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>><br>void</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#run-R-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-java.lang.String...-">run</a></span>(R runnable, |
| <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, |
| <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">Convenience method to allow command line application authors to avoid some boilerplate code in their application.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static void</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#usage-java.lang.Object-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">usage</a></span>(<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, |
| <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">Equivalent to <code>new CommandLine(command).usage(out, ansi)</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</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#usage-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">usage</a></span>(<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">Delegates to <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#usage-java.io.PrintStream-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.ColorScheme-"><code>CommandLine.usage(PrintStream, Help.ColorScheme)</code></a> with the <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#defaultColorScheme-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">default color scheme</a>.</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.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</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.Help.ColorScheme.html#ColorScheme-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">ColorScheme</a></span>(<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">Constructs a new ColorScheme with the specified Ansi enabled mode.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#Help-java.lang.Object-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">Help</a></span>(<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, |
| <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">Constructs a new <code>Help</code> instance with a default color scheme, initialized from annotatations |
| on the specified class and superclasses.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#TextTable-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">TextTable</a></span>(<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">Constructs a TextTable with five columns as follows: |
| |
| required option/parameter marker (width: 2, indent: 0, TRUNCATE on overflow) |
| short option name (width: 2, indent: 0, TRUNCATE on overflow) |
| comma separator (width: 1, indent: 0, TRUNCATE on overflow) |
| long option name(s) (width: 24, indent: 1, SPAN multiple columns on overflow) |
| description line(s) (width: 51, indent: 1, WRAP to next row on overflow) |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#TextTable-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column...-">TextTable</a></span>(<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, |
| <a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Column.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Column</a>... columns)</code> |
| <div class="block">Constructs a <code>TextTable</code> with the specified columns.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#TextTable-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-int...-">TextTable</a></span>(<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, |
| int... columnWidths)</code> |
| <div class="block">Constructs a new TextTable with columns with the specified width, all SPANning multiple columns on |
| overflow except the last column which WRAPS to the next row.</div> |
| </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.Help.Ansi.html" title="enum 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.Help.Ansi.html" target="_top">Frames</a></li> |
| <li><a href="CommandLine.Help.Ansi.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> |
