| <!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 Sat Apr 25 12:11:40 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CommandLine.Help (Apache Log4j Core 2.13.2 API)</title> |
| <meta name="date" content="2020-04-25"> |
| <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="CommandLine.Help (Apache Log4j Core 2.13.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":10,"i16":9,"i17":10,"i18":10,"i19":42,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":9,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":9,"i33":42,"i34":10,"i35":10,"i36":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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 class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CommandLine.Help.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><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.ExecutionException.html" title="class in org.apache.logging.log4j.core.tools.picocli"><span class="typeNameLink">Prev Class</span></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"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html" target="_top">Frames</a></li> |
| <li><a href="CommandLine.Help.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.logging.log4j.core.tools.picocli</div> |
| <h2 title="Class CommandLine.Help" class="title">Class CommandLine.Help</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.core.tools.picocli.CommandLine.Help</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.html#line.2816">CommandLine.Help</a> |
| extends <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></pre> |
| <div class="block">A collection of methods and inner classes that provide fine-grained control over the contents and layout of |
| the usage help message to display to end users when help is requested or invalid input values were specified. |
| <h3>Layered API</h3> |
| <p>The <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Command</code></a> annotation provides the easiest way to customize usage help messages. See |
| the <a href="https://remkop.github.io/picocli/index.html#_usage_help">Manual</a> for details.</p> |
| <p>This Help class provides high-level functions to create sections of the usage help message and headings |
| for these sections. Instead of calling the <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, CommandLine.Help.ColorScheme)</code></a> |
| method, application authors may want to create a custom usage help message by reorganizing sections in a |
| different order and/or adding custom sections.</p> |
| <p>Finally, the Help class contains inner classes and interfaces that can be used to create custom help messages.</p> |
| <h4>IOptionRenderer and IParameterRenderer</h4> |
| <p>Renders a field annotated with <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Option</code></a> or <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Parameters.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Parameters</code></a> to an array of <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.Ansi.Text</code></a> values. |
| By default, these values are</p><ul> |
| <li>mandatory marker character (if the option/parameter is <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html#required--"><code>required</code></a>)</li> |
| <li>short option name (empty for parameters)</li> |
| <li>comma or empty (empty for parameters)</li> |
| <li>long option names (the parameter <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli"><code>label</code></a> for parameters)</li> |
| <li>description</li> |
| </ul> |
| <p>Other components rely on this ordering.</p> |
| <h4>Layout</h4> |
| <p>Delegates to the renderers to create <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.Ansi.Text</code></a> values for the annotated fields, and uses a |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.TextTable</code></a> to display these values in tabular format. Layout is responsible for deciding which values |
| to display where in the table. By default, Layout shows one option or parameter per table row.</p> |
| <h4>TextTable</h4> |
| <p>Responsible for spacing out <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.Ansi.Text</code></a> values according to the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Column.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.Column</code></a> definitions the table was |
| created with. Columns have a width, indentation, and an overflow policy that decides what to do if a value is |
| longer than the column's width.</p> |
| <h4>Text</h4> |
| <p>Encapsulates rich text with styles and colors in a way that other components like <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.TextTable</code></a> are |
| unaware of the embedded ANSI escape codes.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></code> |
| <div class="block">Provides methods and inner classes to support using ANSI escape codes in usage help messages.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></span></code> |
| <div class="block">All usage help message are generated with a color scheme that assigns certain styles and colors to common |
| parts of a usage message: the command name, options, positional parameters and option parameters.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></span></code> |
| <div class="block">Columns define the width, indent (leading number of spaces in a column before the value) and |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Column.Overflow.html" title="enum in org.apache.logging.log4j.core.tools.picocli">Overflow</a> policy of a column in a <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html" title="class in org.apache.logging.log4j.core.tools.picocli">TextTable</a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IOptionRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IOptionRenderer</a></span></code> |
| <div class="block">When customizing online help for <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>Option</code></a> details, a custom <code>IOptionRenderer</code> can be |
| used to create textual representation of an Option in a tabular format: one or more rows, each containing |
| one or more columns.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParameterRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParameterRenderer</a></span></code> |
| <div class="block">When customizing online help for <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Parameters.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>Parameters</code></a> details, a custom <code>IParameterRenderer</code> |
| can be used to create textual representation of a Parameters field in a tabular format: one or more rows, |
| each containing one or more columns.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a></span></code> |
| <div class="block">When customizing online usage help for an option parameter or a positional parameter, a custom |
| <code>IParamLabelRenderer</code> can be used to render the parameter name or label to a String.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Layout</a></span></code> |
| <div class="block">Use a Layout to format usage help text for options and parameters in tabular format.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.TextTable</a></span></code> |
| <div class="block">Responsible for spacing out <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.Ansi.Text</code></a> values according to the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Column.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.Column</code></a> definitions the table was |
| created with.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#abbreviateSynopsis">abbreviateSynopsis</a></span></code> |
| <div class="block">If <code>true</code>, the synopsis line(s) will show an abbreviated synopsis without detailed option names.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#commandListHeading">commandListHeading</a></span></code> |
| <div class="block">Optional heading preceding the subcommand list.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#commandName">commandName</a></span></code> |
| <div class="block">The String to use as the program name in the synopsis line of the help message.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#customSynopsis">customSynopsis</a></span></code> |
| <div class="block">Optional custom synopsis lines to use instead of the auto-generated synopsis.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#DEFAULT_COMMAND_NAME">DEFAULT_COMMAND_NAME</a></span></code> |
| <div class="block">Constant String holding the default program name: "<main class>"</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#DEFAULT_SEPARATOR">DEFAULT_SEPARATOR</a></span></code> |
| <div class="block">Constant String holding the default string that separates options from option parameters: "="</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#description">description</a></span></code> |
| <div class="block">Optional text lines to use as the description of the help message, displayed between the synopsis and the |
| options list.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#descriptionHeading">descriptionHeading</a></span></code> |
| <div class="block">Optional heading preceding the description section.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#footer">footer</a></span></code> |
| <div class="block">Optional footer text lines displayed at the bottom of the help message.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#footerHeading">footerHeading</a></span></code> |
| <div class="block">Optional heading preceding the footer section.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#header">header</a></span></code> |
| <div class="block">Optional header lines displayed at the top of the help message.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#headerHeading">headerHeading</a></span></code> |
| <div class="block">Optional heading preceding the header section.</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/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#optionFields">optionFields</a></span></code> |
| <div class="block">Immutable list of fields annotated with <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Option</code></a>, in declaration order.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#optionListHeading">optionListHeading</a></span></code> |
| <div class="block">Optional heading preceding the options list.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#parameterLabelRenderer">parameterLabelRenderer</a></span></code> |
| <div class="block">Option and positional parameter value label renderer used for the synopsis line(s) and the option list.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#parameterListHeading">parameterListHeading</a></span></code> |
| <div class="block">Optional heading preceding the parameter list.</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/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#positionalParametersFields">positionalParametersFields</a></span></code> |
| <div class="block">Immutable list of fields annotated with <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Parameters.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Parameters</code></a>, or an empty list if no such field exists.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#requiredOptionMarker">requiredOptionMarker</a></span></code> |
| <div class="block">Character used to prefix required options in the options list.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#separator">separator</a></span></code> |
| <div class="block">The String to use as the separator between options and option parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#showDefaultValues">showDefaultValues</a></span></code> |
| <div class="block">If <code>true</code>, the options list will show default values for all options except booleans.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#sortOptions">sortOptions</a></span></code> |
| <div class="block">If <code>true</code>, the options list is sorted alphabetically.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#synopsisHeading">synopsisHeading</a></span></code> |
| <div class="block">Optional heading preceding the synopsis.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#Help-java.lang.Object-">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)</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="rowColor"> |
| <td class="colOne"><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="colOne"><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.ColorScheme-">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.ColorScheme.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.ColorScheme</a> colorScheme)</code> |
| <div class="block">Constructs a new <code>Help</code> instance with the specified color scheme, initialized from annotatations |
| on the specified class and superclasses.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#abbreviatedSynopsis--">abbreviatedSynopsis</a></span>()</code> |
| <div class="block">Generates a generic synopsis like <code><command name> [OPTIONS] [PARAM1 [PARAM2]...]</code>, omitting parts |
| that don't apply to the command (e.g., does not show [OPTIONS] if the command has no options).</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <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"><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 id="i2" 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"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.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> commandName, |
| <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 the specified subcommand with this Help.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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"><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 id="i4" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#commandList--">commandList</a></span>()</code> |
| <div class="block">Returns a 2-column list with command names and the first line of their header or (if absent) description.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#commandListHeading-java.lang.Object...-">commandListHeading</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>... params)</code> |
| <div class="block">Returns the text displayed before the command list; an empty string if there are no commands, |
| otherwise the result of <code>String.format(commandListHeading, params)</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Layout</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createDefaultLayout--">createDefaultLayout</a></span>()</code> |
| <div class="block">Returns a <code>Layout</code> instance configured with the user preferences captured in this Help instance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IOptionRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IOptionRenderer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createDefaultOptionRenderer--">createDefaultOptionRenderer</a></span>()</code> |
| <div class="block">Returns a new default OptionRenderer which converts <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>Options</code></a> to five columns of text to match |
| the default <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html" title="class in org.apache.logging.log4j.core.tools.picocli">TextTable</a> column layout.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParameterRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParameterRenderer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createDefaultParameterRenderer--">createDefaultParameterRenderer</a></span>()</code> |
| <div class="block">Returns a new default ParameterRenderer which converts <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Parameters.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>Parameters</code></a> to four columns of |
| text to match the default <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html" title="class in org.apache.logging.log4j.core.tools.picocli">TextTable</a> column layout.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createDefaultParamLabelRenderer--">createDefaultParamLabelRenderer</a></span>()</code> |
| <div class="block">Returns a new default value renderer that separates option parameters from their <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli">options</a> with the specified separator string, surrounds optional parameters with <code>'['</code> and <code>']'</code> |
| characters and uses ellipses ("...") to indicate that any number of a parameter are allowed.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IOptionRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IOptionRenderer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createMinimalOptionRenderer--">createMinimalOptionRenderer</a></span>()</code> |
| <div class="block">Returns a new minimal OptionRenderer which converts <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>Options</code></a> to a single row with two columns |
| of text: an option name and a description.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParameterRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParameterRenderer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createMinimalParameterRenderer--">createMinimalParameterRenderer</a></span>()</code> |
| <div class="block">Returns a new minimal ParameterRenderer which converts <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Parameters.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>Parameters</code></a> to a single row with |
| two columns of text: an option name and a description.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createMinimalParamLabelRenderer--">createMinimalParamLabelRenderer</a></span>()</code> |
| <div class="block">Returns a value renderer that returns the <code>paramLabel</code> if defined or the field name otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createShortOptionArityAndNameComparator--">createShortOptionArityAndNameComparator</a></span>()</code> |
| <div class="block">Sorts Fields annotated with <code>Option</code> by their option <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Range.html#max">max arity</a> first, by |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Range.html#min">min arity</a> next, and by <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createShortOptionNameComparator--">option name</a> last.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createShortOptionNameComparator--">createShortOptionNameComparator</a></span>()</code> |
| <div class="block">Sorts Fields annotated with <code>Option</code> by their option name in case-insensitive alphabetic order.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#customSynopsis-java.lang.Object...-">customSynopsis</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>... params)</code> |
| <div class="block">Returns command custom synopsis as a string.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <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"><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 id="i17" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#description-java.lang.Object...-">description</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>... params)</code> |
| <div class="block">Returns command description text as a string.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#descriptionHeading-java.lang.Object...-">descriptionHeading</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>... params)</code> |
| <div class="block">Returns the text displayed before the description text; an empty string if there is no description, |
| otherwise the result of <code>String.format(descriptionHeading, params)</code>.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#detailedSynopsis-java.util.Comparator-boolean-">detailedSynopsis</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<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>> optionSort, |
| boolean clusterBooleanOptions)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#detailedSynopsis-int-java.util.Comparator-boolean-"><code>detailedSynopsis(int, Comparator, boolean)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#detailedSynopsis-int-java.util.Comparator-boolean-">detailedSynopsis</a></span>(int synopsisHeadingLength, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<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>> optionSort, |
| boolean clusterBooleanOptions)</code> |
| <div class="block">Generates a detailed synopsis message showing all options and parameters.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#footer-java.lang.Object...-">footer</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>... params)</code> |
| <div class="block">Returns command footer text as a string.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#footerHeading-java.lang.Object...-">footerHeading</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>... params)</code> |
| <div class="block">Returns the text displayed before the footer text; the result of <code>String.format(footerHeading, params)</code>.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#header-java.lang.Object...-">header</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>... params)</code> |
| <div class="block">Returns the command header text as a string.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#headerHeading-java.lang.Object...-">headerHeading</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>... params)</code> |
| <div class="block">Returns the text displayed before the header text; the result of <code>String.format(headerHeading, params)</code>.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <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"><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 id="i26" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#optionList--">optionList</a></span>()</code> |
| <div class="block">Returns a description of the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli">options</a> supported by the application.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#optionList-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Layout-java.util.Comparator-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.IParamLabelRenderer-">optionList</a></span>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Layout</a> layout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<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>> optionSort, |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a> valueLabelRenderer)</code> |
| <div class="block">Sorts all <code>Options</code> with the specified <code>comparator</code> (if the comparator is non-<code>null</code>), |
| then <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html#addOption-java.lang.reflect.Field-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.IParamLabelRenderer-">adds</a> all non-hidden options to the |
| specified TextTable and returns the result of TextTable.toString().</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#optionListHeading-java.lang.Object...-">optionListHeading</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>... params)</code> |
| <div class="block">Returns the text displayed before the option list; an empty string if there are no options, |
| otherwise the result of <code>String.format(optionListHeading, params)</code>.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#parameterList--">parameterList</a></span>()</code> |
| <div class="block">Returns the section of the usage help message that lists the parameters with their descriptions.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#parameterList-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Layout-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.IParamLabelRenderer-">parameterList</a></span>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Layout</a> layout, |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a> paramLabelRenderer)</code> |
| <div class="block">Returns the section of the usage help message that lists the parameters with their descriptions.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#parameterListHeading-java.lang.Object...-">parameterListHeading</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>... params)</code> |
| <div class="block">Returns the text displayed before the positional parameter list; an empty string if there are no positional |
| parameters, otherwise the result of <code>String.format(parameterListHeading, params)</code>.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#shortestFirst--">shortestFirst</a></span>()</code> |
| <div class="block">Sorts short strings before longer strings.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#synopsis--">synopsis</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#synopsis-int-"><code>synopsis(int)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#synopsis-int-">synopsis</a></span>(int synopsisHeadingLength)</code> |
| <div class="block">Returns a synopsis for the command, reserving the specified space for the synopsis heading.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#synopsisHeading-java.lang.Object...-">synopsisHeading</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>... params)</code> |
| <div class="block">Returns the text displayed before the synopsis text; the result of <code>String.format(synopsisHeading, params)</code>.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#synopsisHeadingLength--">synopsisHeadingLength</a></span>()</code> |
| <div class="block">Returns the number of characters the synopsis heading will take on the same line as the synopsis.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_COMMAND_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_COMMAND_NAME</h4> |
| <pre>protected static final <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2818">DEFAULT_COMMAND_NAME</a></pre> |
| <div class="block">Constant String holding the default program name: "<main class>"</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.DEFAULT_COMMAND_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_SEPARATOR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_SEPARATOR</h4> |
| <pre>protected static final <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2821">DEFAULT_SEPARATOR</a></pre> |
| <div class="block">Constant String holding the default string that separates options from option parameters: "="</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.DEFAULT_SEPARATOR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="optionFields"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>optionFields</h4> |
| <pre>public final <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/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2830">optionFields</a></pre> |
| <div class="block">Immutable list of fields annotated with <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Option</code></a>, in declaration order.</div> |
| </li> |
| </ul> |
| <a name="positionalParametersFields"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>positionalParametersFields</h4> |
| <pre>public final <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/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a>> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2833">positionalParametersFields</a></pre> |
| <div class="block">Immutable list of fields annotated with <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Parameters.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Parameters</code></a>, or an empty list if no such field exists.</div> |
| </li> |
| </ul> |
| <a name="separator"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>separator</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2838">separator</a></pre> |
| <div class="block">The String to use as the separator between options and option parameters. <code>"="</code> by default, |
| initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#separator--"><code>CommandLine.Command.separator()</code></a> if defined.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#parameterLabelRenderer"><code>parameterLabelRenderer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="commandName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commandName</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2842">commandName</a></pre> |
| <div class="block">The String to use as the program name in the synopsis line of the help message. |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#DEFAULT_COMMAND_NAME"><code>DEFAULT_COMMAND_NAME</code></a> by default, initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#name--"><code>CommandLine.Command.name()</code></a> if defined.</div> |
| </li> |
| </ul> |
| <a name="description"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>description</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2848">description</a></pre> |
| <div class="block">Optional text lines to use as the description of the help message, displayed between the synopsis and the |
| options list. Initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#description--"><code>CommandLine.Command.description()</code></a> if the <code>Command</code> annotation is present, |
| otherwise this is an empty array and the help message has no description. |
| Applications may programmatically set this field to create a custom help message.</div> |
| </li> |
| </ul> |
| <a name="customSynopsis"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>customSynopsis</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2854">customSynopsis</a></pre> |
| <div class="block">Optional custom synopsis lines to use instead of the auto-generated synopsis. |
| Initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#customSynopsis--"><code>CommandLine.Command.customSynopsis()</code></a> if the <code>Command</code> annotation is present, |
| otherwise this is an empty array and the synopsis is generated. |
| Applications may programmatically set this field to create a custom help message.</div> |
| </li> |
| </ul> |
| <a name="header"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>header</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2860">header</a></pre> |
| <div class="block">Optional header lines displayed at the top of the help message. For subcommands, the first header line is |
| displayed in the list of commands. Values are initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#header--"><code>CommandLine.Command.header()</code></a> |
| if the <code>Command</code> annotation is present, otherwise this is an empty array and the help message has no |
| header. Applications may programmatically set this field to create a custom help message.</div> |
| </li> |
| </ul> |
| <a name="footer"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>footer</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2866">footer</a></pre> |
| <div class="block">Optional footer text lines displayed at the bottom of the help message. Initialized from |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#footer--"><code>CommandLine.Command.footer()</code></a> if the <code>Command</code> annotation is present, otherwise this is an empty array and |
| the help message has no footer. |
| Applications may programmatically set this field to create a custom help message.</div> |
| </li> |
| </ul> |
| <a name="parameterLabelRenderer"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameterLabelRenderer</h4> |
| <pre>public <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2872">parameterLabelRenderer</a></pre> |
| <div class="block">Option and positional parameter value label renderer used for the synopsis line(s) and the option list. |
| By default initialized to the result of <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createDefaultParamLabelRenderer--"><code>createDefaultParamLabelRenderer()</code></a>, which takes a snapshot |
| of the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#separator"><code>separator</code></a> at construction time. If the separator is modified after Help construction, you |
| may need to re-initialize this field by calling <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createDefaultParamLabelRenderer--"><code>createDefaultParamLabelRenderer()</code></a> again.</div> |
| </li> |
| </ul> |
| <a name="abbreviateSynopsis"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>abbreviateSynopsis</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2875">abbreviateSynopsis</a></pre> |
| <div class="block">If <code>true</code>, the synopsis line(s) will show an abbreviated synopsis without detailed option names.</div> |
| </li> |
| </ul> |
| <a name="sortOptions"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sortOptions</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2878">sortOptions</a></pre> |
| <div class="block">If <code>true</code>, the options list is sorted alphabetically.</div> |
| </li> |
| </ul> |
| <a name="showDefaultValues"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>showDefaultValues</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2881">showDefaultValues</a></pre> |
| <div class="block">If <code>true</code>, the options list will show default values for all options except booleans.</div> |
| </li> |
| </ul> |
| <a name="requiredOptionMarker"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiredOptionMarker</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2884">requiredOptionMarker</a></pre> |
| <div class="block">Character used to prefix required options in the options list.</div> |
| </li> |
| </ul> |
| <a name="headerHeading"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>headerHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2887">headerHeading</a></pre> |
| <div class="block">Optional heading preceding the header section. Initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#headerHeading--"><code>CommandLine.Command.headerHeading()</code></a>, or null.</div> |
| </li> |
| </ul> |
| <a name="synopsisHeading"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>synopsisHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2890">synopsisHeading</a></pre> |
| <div class="block">Optional heading preceding the synopsis. Initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#synopsisHeading--"><code>CommandLine.Command.synopsisHeading()</code></a>, <code>"Usage: "</code> by default.</div> |
| </li> |
| </ul> |
| <a name="descriptionHeading"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>descriptionHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2893">descriptionHeading</a></pre> |
| <div class="block">Optional heading preceding the description section. Initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#descriptionHeading--"><code>CommandLine.Command.descriptionHeading()</code></a>, or null.</div> |
| </li> |
| </ul> |
| <a name="parameterListHeading"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameterListHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2896">parameterListHeading</a></pre> |
| <div class="block">Optional heading preceding the parameter list. Initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#parameterListHeading--"><code>CommandLine.Command.parameterListHeading()</code></a>, or null.</div> |
| </li> |
| </ul> |
| <a name="optionListHeading"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>optionListHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2899">optionListHeading</a></pre> |
| <div class="block">Optional heading preceding the options list. Initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#optionListHeading--"><code>CommandLine.Command.optionListHeading()</code></a>, or null.</div> |
| </li> |
| </ul> |
| <a name="commandListHeading"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commandListHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2902">commandListHeading</a></pre> |
| <div class="block">Optional heading preceding the subcommand list. Initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#commandListHeading--"><code>CommandLine.Command.commandListHeading()</code></a>. <code>"Commands:%n"</code> by default.</div> |
| </li> |
| </ul> |
| <a name="footerHeading"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>footerHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2905">footerHeading</a></pre> |
| <div class="block">Optional heading preceding the footer section. Initialized from <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#footerHeading--"><code>CommandLine.Command.footerHeading()</code></a>, or null.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Help-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Help</h4> |
| <pre>public <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2910">Help</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> command)</pre> |
| <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> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - the annotated object to create usage help for</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="Help-java.lang.Object-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Help</h4> |
| <pre>public <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2918">Help</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> 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)</pre> |
| <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> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - the annotated object to create usage help for</dd> |
| <dd><code>ansi</code> - whether to emit ANSI escape codes or not</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="Help-java.lang.Object-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.ColorScheme-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Help</h4> |
| <pre>public <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2926">Help</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> command, |
| <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> colorScheme)</pre> |
| <div class="block">Constructs a new <code>Help</code> instance with the specified color scheme, initialized from annotatations |
| on the specified class and superclasses.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - the annotated object to create usage help for</dd> |
| <dd><code>colorScheme</code> - the color scheme to use</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addAllSubcommands-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAllSubcommands</h4> |
| <pre>public <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> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.2989">addAllSubcommands</a>(<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)</pre> |
| <div class="block">Registers all specified subcommands with this Help.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>commands</code> - maps the command names to the associated CommandLine object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Help instance (for method chaining)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#getSubcommands--"><code>CommandLine.getSubcommands()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addSubcommand-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSubcommand</h4> |
| <pre>public <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> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3003">addSubcommand</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> commandName, |
| <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)</pre> |
| <div class="block">Registers the specified subcommand with this Help.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>commandName</code> - the name of the subcommand to display in the usage message</dd> |
| <dd><code>command</code> - the annotated object to get more information from</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Help instance (for method chaining)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="synopsis--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>synopsis</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3015">synopsis</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#synopsis-int-"><code>synopsis(int)</code></a> instead</span></div> |
| <div class="block">Returns a synopsis for the command without reserving space for the synopsis heading.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a synopsis</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#abbreviatedSynopsis--"><code>abbreviatedSynopsis()</code></a>, |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#detailedSynopsis-java.util.Comparator-boolean-"><code>detailedSynopsis(Comparator, boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="synopsis-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>synopsis</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3025">synopsis</a>(int synopsisHeadingLength)</pre> |
| <div class="block">Returns a synopsis for the command, reserving the specified space for the synopsis heading.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>synopsisHeadingLength</code> - the length of the synopsis heading that will be displayed on the same line</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a synopsis</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#abbreviatedSynopsis--"><code>abbreviatedSynopsis()</code></a>, |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#detailedSynopsis-java.util.Comparator-boolean-"><code>detailedSynopsis(Comparator, boolean)</code></a>, |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#synopsisHeading"><code>synopsisHeading</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="abbreviatedSynopsis--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>abbreviatedSynopsis</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3034">abbreviatedSynopsis</a>()</pre> |
| <div class="block">Generates a generic synopsis like <code><command name> [OPTIONS] [PARAM1 [PARAM2]...]</code>, omitting parts |
| that don't apply to the command (e.g., does not show [OPTIONS] if the command has no options).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a generic synopsis</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="detailedSynopsis-java.util.Comparator-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>detailedSynopsis</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3055">detailedSynopsis</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<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>> optionSort, |
| boolean clusterBooleanOptions)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#detailedSynopsis-int-java.util.Comparator-boolean-"><code>detailedSynopsis(int, Comparator, boolean)</code></a> instead.</span></div> |
| <div class="block">Generates a detailed synopsis message showing all options and parameters. Follows the unix convention of |
| showing optional options and parameters in square brackets (<code>[ ]</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>optionSort</code> - comparator to sort options or <code>null</code> if options should not be sorted</dd> |
| <dd><code>clusterBooleanOptions</code> - <code>true</code> if boolean short options should be clustered into a single string</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a detailed synopsis</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="detailedSynopsis-int-java.util.Comparator-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>detailedSynopsis</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3065">detailedSynopsis</a>(int synopsisHeadingLength, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<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>> optionSort, |
| boolean clusterBooleanOptions)</pre> |
| <div class="block">Generates a detailed synopsis message showing all options and parameters. Follows the unix convention of |
| showing optional options and parameters in square brackets (<code>[ ]</code>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>synopsisHeadingLength</code> - the length of the synopsis heading that will be displayed on the same line</dd> |
| <dd><code>optionSort</code> - comparator to sort options or <code>null</code> if options should not be sorted</dd> |
| <dd><code>clusterBooleanOptions</code> - <code>true</code> if boolean short options should be clustered into a single string</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a detailed synopsis</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="synopsisHeadingLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>synopsisHeadingLength</h4> |
| <pre>public int <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3145">synopsisHeadingLength</a>()</pre> |
| <div class="block">Returns the number of characters the synopsis heading will take on the same line as the synopsis.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of characters the synopsis heading will take on the same line as the synopsis.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#detailedSynopsis-int-java.util.Comparator-boolean-"><code>detailedSynopsis(int, Comparator, boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="optionList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>optionList</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3157">optionList</a>()</pre> |
| <div class="block"><p>Returns a description of the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli">options</a> supported by the application. |
| This implementation <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createShortOptionNameComparator--">sorts options alphabetically</a>, and shows |
| only the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html#hidden--">non-hidden</a> options in a <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html" title="class in org.apache.logging.log4j.core.tools.picocli">tabular format</a> |
| using the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createDefaultOptionRenderer--">default renderer</a> and <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html" title="class in org.apache.logging.log4j.core.tools.picocli">default layout</a>.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the fully formatted option list</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#optionList-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Layout-java.util.Comparator-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.IParamLabelRenderer-"><code>optionList(Layout, Comparator, IParamLabelRenderer)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="optionList-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Layout-java.util.Comparator-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.IParamLabelRenderer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>optionList</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3172">optionList</a>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Layout</a> layout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<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>> optionSort, |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a> valueLabelRenderer)</pre> |
| <div class="block">Sorts all <code>Options</code> with the specified <code>comparator</code> (if the comparator is non-<code>null</code>), |
| then <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html#addOption-java.lang.reflect.Field-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.IParamLabelRenderer-">adds</a> all non-hidden options to the |
| specified TextTable and returns the result of TextTable.toString().</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>layout</code> - responsible for rendering the option list</dd> |
| <dd><code>optionSort</code> - determines in what order <code>Options</code> should be listed. Declared order if <code>null</code></dd> |
| <dd><code>valueLabelRenderer</code> - used for options with a parameter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the fully formatted option list</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parameterList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameterList</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3185">parameterList</a>()</pre> |
| <div class="block">Returns the section of the usage help message that lists the parameters with their descriptions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the section of the usage help message that lists the parameters</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parameterList-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Layout-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.IParamLabelRenderer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameterList</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3194">parameterList</a>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Layout</a> layout, |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a> paramLabelRenderer)</pre> |
| <div class="block">Returns the section of the usage help message that lists the parameters with their descriptions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>layout</code> - the layout to use</dd> |
| <dd><code>paramLabelRenderer</code> - for rendering parameter names</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the section of the usage help message that lists the parameters</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="join-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-java.lang.String:A-java.lang.StringBuilder-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>join</h4> |
| <pre>public 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> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3220">join</a>(<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)</pre> |
| <div class="block">Formats each of the specified values and appends it to the specified StringBuilder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ansi</code> - whether the result should contain ANSI escape codes or not</dd> |
| <dd><code>values</code> - the values to format and append to the StringBuilder</dd> |
| <dd><code>sb</code> - the StringBuilder to collect the formatted strings</dd> |
| <dd><code>params</code> - the parameters to pass to the format method when formatting each value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the specified StringBuilder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="customSynopsis-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>customSynopsis</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3241">customSynopsis</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>... params)</pre> |
| <div class="block">Returns command custom synopsis as a string. A custom synopsis can be zero or more lines, and can be |
| specified declaratively with the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#customSynopsis--"><code>CommandLine.Command.customSynopsis()</code></a> annotation attribute or programmatically |
| by setting the Help instance's <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#customSynopsis"><code>customSynopsis</code></a> field.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - Arguments referenced by the format specifiers in the synopsis strings</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the custom synopsis lines combined into a single String (which may be empty)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="description-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>description</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3250">description</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>... params)</pre> |
| <div class="block">Returns command description text as a string. Description text can be zero or more lines, and can be specified |
| declaratively with the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#description--"><code>CommandLine.Command.description()</code></a> annotation attribute or programmatically by |
| setting the Help instance's <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#description"><code>description</code></a> field.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - Arguments referenced by the format specifiers in the description strings</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the description lines combined into a single String (which may be empty)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="header-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>header</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3259">header</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>... params)</pre> |
| <div class="block">Returns the command header text as a string. Header text can be zero or more lines, and can be specified |
| declaratively with the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#header--"><code>CommandLine.Command.header()</code></a> annotation attribute or programmatically by |
| setting the Help instance's <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#header"><code>header</code></a> field.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - Arguments referenced by the format specifiers in the header strings</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the header lines combined into a single String (which may be empty)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="footer-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>footer</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3268">footer</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>... params)</pre> |
| <div class="block">Returns command footer text as a string. Footer text can be zero or more lines, and can be specified |
| declaratively with the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Command.html#footer--"><code>CommandLine.Command.footer()</code></a> annotation attribute or programmatically by |
| setting the Help instance's <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#footer"><code>footer</code></a> field.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - Arguments referenced by the format specifiers in the footer strings</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the footer lines combined into a single String (which may be empty)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="headerHeading-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>headerHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3275">headerHeading</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>... params)</pre> |
| <div class="block">Returns the text displayed before the header text; the result of <code>String.format(headerHeading, params)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - the parameters to use to format the header heading</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the formatted header heading</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="synopsisHeading-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>synopsisHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3282">synopsisHeading</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>... params)</pre> |
| <div class="block">Returns the text displayed before the synopsis text; the result of <code>String.format(synopsisHeading, params)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - the parameters to use to format the synopsis heading</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the formatted synopsis heading</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="descriptionHeading-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>descriptionHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3290">descriptionHeading</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>... params)</pre> |
| <div class="block">Returns the text displayed before the description text; an empty string if there is no description, |
| otherwise the result of <code>String.format(descriptionHeading, params)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - the parameters to use to format the description heading</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the formatted description heading</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parameterListHeading-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parameterListHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3298">parameterListHeading</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>... params)</pre> |
| <div class="block">Returns the text displayed before the positional parameter list; an empty string if there are no positional |
| parameters, otherwise the result of <code>String.format(parameterListHeading, params)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - the parameters to use to format the parameter list heading</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the formatted parameter list heading</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="optionListHeading-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>optionListHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3306">optionListHeading</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>... params)</pre> |
| <div class="block">Returns the text displayed before the option list; an empty string if there are no options, |
| otherwise the result of <code>String.format(optionListHeading, params)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - the parameters to use to format the option list heading</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the formatted option list heading</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="commandListHeading-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commandListHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3314">commandListHeading</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>... params)</pre> |
| <div class="block">Returns the text displayed before the command list; an empty string if there are no commands, |
| otherwise the result of <code>String.format(commandListHeading, params)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - the parameters to use to format the command list heading</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the formatted command list heading</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="footerHeading-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>footerHeading</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3321">footerHeading</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>... params)</pre> |
| <div class="block">Returns the text displayed before the footer text; the result of <code>String.format(footerHeading, params)</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - the parameters to use to format the footer heading</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the formatted footer heading</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="commandList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commandList</h4> |
| <pre>public <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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3326">commandList</a>()</pre> |
| <div class="block">Returns a 2-column list with command names and the first line of their header or (if absent) description.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a usage help section describing the added commands</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createDefaultLayout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDefaultLayout</h4> |
| <pre>public <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Layout</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3362">createDefaultLayout</a>()</pre> |
| <div class="block">Returns a <code>Layout</code> instance configured with the user preferences captured in this Help instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Layout</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createDefaultOptionRenderer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDefaultOptionRenderer</h4> |
| <pre>public <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IOptionRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IOptionRenderer</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3379">createDefaultOptionRenderer</a>()</pre> |
| <div class="block">Returns a new default OptionRenderer which converts <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>Options</code></a> to five columns of text to match |
| the default <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html" title="class in org.apache.logging.log4j.core.tools.picocli">TextTable</a> column layout. The first row of values looks like this: |
| <ol> |
| <li>the required option marker</li> |
| <li>2-character short option name (or empty string if no short option exists)</li> |
| <li>comma separator (only if both short option and long option exist, empty string otherwise)</li> |
| <li>comma-separated string with long option name(s)</li> |
| <li>first element of the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html#description--"><code>CommandLine.Option.description()</code></a> array</li> |
| </ol> |
| <p>Following this, there will be one row for each of the remaining elements of the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html#description--"><code>CommandLine.Option.description()</code></a> array, and these rows look like <code>{"", "", "", "", option.description()[i]}</code>.</p> |
| <p>If configured, this option renderer adds an additional row to display the default field value.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new default OptionRenderer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createMinimalOptionRenderer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createMinimalOptionRenderer</h4> |
| <pre>public static <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IOptionRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IOptionRenderer</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3390">createMinimalOptionRenderer</a>()</pre> |
| <div class="block">Returns a new minimal OptionRenderer which converts <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>Options</code></a> to a single row with two columns |
| of text: an option name and a description. If multiple names or descriptions exist, the first value is used.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new minimal OptionRenderer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createDefaultParameterRenderer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDefaultParameterRenderer</h4> |
| <pre>public <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParameterRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParameterRenderer</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3407">createDefaultParameterRenderer</a>()</pre> |
| <div class="block">Returns a new default ParameterRenderer which converts <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Parameters.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>Parameters</code></a> to four columns of |
| text to match the default <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html" title="class in org.apache.logging.log4j.core.tools.picocli">TextTable</a> column layout. The first row of values looks like this: |
| <ol> |
| <li>empty string </li> |
| <li>empty string </li> |
| <li>parameter(s) label as rendered by the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.IParamLabelRenderer</code></a></li> |
| <li>first element of the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Parameters.html#description--"><code>CommandLine.Parameters.description()</code></a> array</li> |
| </ol> |
| <p>Following this, there will be one row for each of the remaining elements of the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Parameters.html#description--"><code>CommandLine.Parameters.description()</code></a> array, and these rows look like <code>{"", "", "", param.description()[i]}</code>.</p> |
| <p>If configured, this parameter renderer adds an additional row to display the default field value.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new default ParameterRenderer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createMinimalParameterRenderer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createMinimalParameterRenderer</h4> |
| <pre>public static <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParameterRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParameterRenderer</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3415">createMinimalParameterRenderer</a>()</pre> |
| <div class="block">Returns a new minimal ParameterRenderer which converts <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Parameters.html" title="annotation in org.apache.logging.log4j.core.tools.picocli"><code>Parameters</code></a> to a single row with |
| two columns of text: an option name and a description. If multiple descriptions exist, the first value is used.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new minimal ParameterRenderer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createMinimalParamLabelRenderer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createMinimalParamLabelRenderer</h4> |
| <pre>public static <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3421">createMinimalParamLabelRenderer</a>()</pre> |
| <div class="block">Returns a value renderer that returns the <code>paramLabel</code> if defined or the field name otherwise.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new minimal ParamLabelRenderer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createDefaultParamLabelRenderer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDefaultParamLabelRenderer</h4> |
| <pre>public <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3437">createDefaultParamLabelRenderer</a>()</pre> |
| <div class="block">Returns a new default value renderer that separates option parameters from their <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Option.html" title="annotation in org.apache.logging.log4j.core.tools.picocli">options</a> with the specified separator string, surrounds optional parameters with <code>'['</code> and <code>']'</code> |
| characters and uses ellipses ("...") to indicate that any number of a parameter are allowed.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new default ParamLabelRenderer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createShortOptionNameComparator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createShortOptionNameComparator</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<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>> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3443">createShortOptionNameComparator</a>()</pre> |
| <div class="block">Sorts Fields annotated with <code>Option</code> by their option name in case-insensitive alphabetic order. If an |
| Option has multiple names, the shortest name is used for the sorting. Help options follow non-help options.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a comparator that sorts fields by their option name in case-insensitive alphabetic order</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createShortOptionArityAndNameComparator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createShortOptionArityAndNameComparator</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><<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>> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3449">createShortOptionArityAndNameComparator</a>()</pre> |
| <div class="block">Sorts Fields annotated with <code>Option</code> by their option <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Range.html#max">max arity</a> first, by |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Range.html#min">min arity</a> next, and by <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#createShortOptionNameComparator--">option name</a> last.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a comparator that sorts fields by arity first, then their option name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shortestFirst--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shortestFirst</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</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="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3454">shortestFirst</a>()</pre> |
| <div class="block">Sorts short strings before longer strings.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a comparators that sorts short strings before longer strings</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ansi--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ansi</h4> |
| <pre>public <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> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3461">ansi</a>()</pre> |
| <div class="block">Returns whether ANSI escape codes are enabled or not.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether ANSI escape codes are enabled or not</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="defaultColorScheme-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>defaultColorScheme</h4> |
| <pre>public 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> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.4244">defaultColorScheme</a>(<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)</pre> |
| <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> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ansi</code> - whether the usage help message should contain ANSI escape codes or not</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new default color scheme</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= 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 class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CommandLine.Help.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><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.ExecutionException.html" title="class in org.apache.logging.log4j.core.tools.picocli"><span class="typeNameLink">Prev Class</span></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"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html" target="_top">Frames</a></li> |
| <li><a href="CommandLine.Help.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |