Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4j / 2.13.2 / log4j-core / apidocs / org / apache / logging / log4j / core / tools / picocli / package-use.html
blob: 186d638c9abf57fa817c8a11bf3715398f2798bd [file] [log] [blame]
<!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:44 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Package org.apache.logging.log4j.core.tools.picocli (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="Uses of Package org.apache.logging.log4j.core.tools.picocli (Apache Log4j Core 2.13.2 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/tools/picocli/package-use.html" target="_top">Frames</a></li>
<li><a href="package-use.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Uses of Package org.apache.logging.log4j.core.tools.picocli" class="title">Uses of Package<br>org.apache.logging.log4j.core.tools.picocli</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/package-summary.html">org.apache.logging.log4j.core.tools.picocli</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.logging.log4j.core.tools.picocli">org.apache.logging.log4j.core.tools.picocli</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.logging.log4j.core.tools.picocli">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/package-summary.html">org.apache.logging.log4j.core.tools.picocli</a> used by <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/package-summary.html">org.apache.logging.log4j.core.tools.picocli</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.html#org.apache.logging.log4j.core.tools.picocli">CommandLine</a>
<div class="block">
CommandLine interpreter that uses reflection to initialize an annotated domain object with values obtained from the
command line arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.ExecutionException.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.ExecutionException</a>
<div class="block">Exception indicating a problem while invoking a command or subcommand.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help</a>
<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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.Ansi.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a>
<div class="block">Provides methods and inner classes to support using ANSI escape codes in usage help messages.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.Ansi.IStyle.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.IStyle</a>
<div class="block">Defines the interface for an ANSI escape sequence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.Ansi.Style.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Style</a>
<div class="block">A set of pre-defined ANSI escape code styles and colors, and a set of convenience methods for parsing
text with embedded markup style names, as well as convenience methods for converting
styles to strings with embedded escape codes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.Ansi.Text.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a>
<div class="block">Encapsulates rich text with styles and colors.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.ColorScheme.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.ColorScheme</a>
<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="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.Column.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Column</a>
<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="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.Column.Overflow.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Column.Overflow</a>
<div class="block">Policy for handling text that is longer than the column width:
span multiple columns, wrap to the next row, or simply truncate the portion that doesn't fit.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.IOptionRenderer.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IOptionRenderer</a>
<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="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.IParameterRenderer.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParameterRenderer</a>
<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="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.IParamLabelRenderer.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.IParamLabelRenderer</a>
<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="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.Layout.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Layout</a>
<div class="block">Use a Layout to format usage help text for options and parameters in tabular format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.TextTable.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.TextTable</a>
<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>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Help.TextTable.Cell.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.TextTable.Cell</a>
<div class="block">Helper class to index positions in a <code>Help.TextTable</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.IExceptionHandler.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.IExceptionHandler</a>
<div class="block">Represents a function that can handle a <code>ParameterException</code> that occurred while
<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#parse-java.lang.String...-">parsing</a> the command line arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.InitializationException.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.InitializationException</a>
<div class="block">Exception indicating a problem during <code>CommandLine</code> initialization.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.IParseResultHandler.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.IParseResultHandler</a>
<div class="block">Represents a function that can process a List of <code>CommandLine</code> objects resulting from successfully
<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.html#parse-java.lang.String...-">parsing</a> the command line arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.ITypeConverter.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.ITypeConverter</a>
<div class="block">
When parsing command line arguments and initializing
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>@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>@Parameters</code></a>,
String values can be converted to any type for which a <code>ITypeConverter</code> is registered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Option.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Option</a>
<div class="block">
Annotate fields in your class with <code>@Option</code> and picocli will initialize these fields when matching
arguments are specified on the command line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.ParameterException.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.ParameterException</a>
<div class="block">Exception indicating something went wrong while parsing command line options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Parameters.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Parameters</a>
<div class="block">
Fields annotated with <code>@Parameters</code> will be initialized with positional parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.PicocliException.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.PicocliException</a>
<div class="block">Base class of all exceptions thrown by <code>picocli.CommandLine</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/class-use/CommandLine.Range.html#org.apache.logging.log4j.core.tools.picocli">CommandLine.Range</a>
<div class="block">Describes the number of parameters required and accepted by an option or a positional parameter.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/tools/picocli/package-use.html" target="_top">Frames</a></li>
<li><a href="package-use.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 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>