Google Git
Sign in
apache / creadur-site / HEAD / . / rat017 / apache-rat-tools / apidocs / org / apache / rat / documentation / options / AntOption.html
blob: f07da3fd509886ae40996354eca9829d85f5ff66 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang>
<head>
<!-- Generated by javadoc (16) -->
<title>AntOption (Apache Creadur RAT::Tools 0.17 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.rat.documentation.options, class: AntOption">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar.top">
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/AntOption.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip.navbar.top">
<!-- -->
</span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.rat.documentation.options</a></div>
<h1 title="Class AntOption" class="title">Class AntOption</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="AbstractOption.html" title="class in org.apache.rat.documentation.options">org.apache.rat.documentation.options.AbstractOption</a>
<div class="inheritance">org.apache.rat.documentation.options.AntOption</div>
</div>
</div>
<section class="description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AntOption</span>
<span class="extends-implements">extends <a href="AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></span></div>
<div class="block">A class that wraps the CLI option and provides Ant specific values.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested.class.summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="AntOption.ExampleGenerator.html" title="class in org.apache.rat.documentation.options">AntOption.ExampleGenerator</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">An example code generator for this AntOption.</div>
</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field.summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields.inherited.from.class.org.apache.rat.documentation.options.AbstractOption">Fields inherited from class&nbsp;org.apache.rat.documentation.options.<a href="AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></h3>
<code><a href="AbstractOption.html#argumentType">argumentType</a>, <a href="AbstractOption.html#name">name</a>, <a href="AbstractOption.html#option">option</a>, <a href="AbstractOption.html#PATTERN">PATTERN</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor.summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(org.apache.commons.cli.Option)">AntOption</a></span>&#8203;(org.apache.commons.cli.Option&nbsp;option)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructor.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method.summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#cleanupName(org.apache.commons.cli.Option)">cleanupName</a></span>&#8203;(org.apache.commons.cli.Option&nbsp;option)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Provide means to wrap the given option depending on the UI-specific option implementation.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;org.apache.commons.cli.Option&gt;</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#convertedFrom()">convertedFrom</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the set of options that are mapped to this option.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#createName(org.apache.commons.cli.Option)">createName</a></span>&#8203;(org.apache.commons.cli.Option&nbsp;option)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getActualAntOption()">getActualAntOption</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">If this option is converted to another option return that option otherwise
return this option.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getAntOptions()">getAntOptions</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the list of all available Ant options.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getAttributeFunctionName()">getAttributeFunctionName</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Get the signature of the attribute function.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getComment(boolean)">getComment</a></span>&#8203;(boolean&nbsp;addParam)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Get the method comment for this option.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getExample()">getExample</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Gets an example of how to use this option in the native UI.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;org.apache.commons.cli.Option&gt;</code></div>
<div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getFilteredOptions()">getFilteredOptions</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the set of options that are not supported by Ant either by not being supported or
by being converted to another argument.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getRenameMap()">getRenameMap</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">&nbsp;</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getText()">getText</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">return a string showing long and short options if they are available.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;org.apache.commons.cli.Option&gt;</code></div>
<div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getUnsupportedOptions()">getUnsupportedOptions</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Gets the list of unsupported options.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#isAttribute()">isAttribute</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Returns <code>true</code> if the option should be an attribute of the &lt;rat:report&gt; element.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#isElement()">isElement</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
<div class="block">Returns <code>true</code> if the option should be a child element of the &lt;rat:report&gt; element.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.org.apache.rat.documentation.options.AbstractOption">Methods inherited from class&nbsp;org.apache.rat.documentation.options.<a href="AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></h3>
<code><a href="AbstractOption.html#argCount()">argCount</a>, <a href="AbstractOption.html#cleanup(java.lang.String)">cleanup</a>, <a href="AbstractOption.html#cleanupName()">cleanupName</a>, <a href="AbstractOption.html#getArgName()">getArgName</a>, <a href="AbstractOption.html#getArgType()">getArgType</a>, <a href="AbstractOption.html#getDefaultValue()">getDefaultValue</a>, <a href="AbstractOption.html#getDeprecated()">getDeprecated</a>, <a href="AbstractOption.html#getDescription()">getDescription</a>, <a href="AbstractOption.html#getName()">getName</a>, <a href="AbstractOption.html#getOption()">getOption</a>, <a href="AbstractOption.html#getType()">getType</a>, <a href="AbstractOption.html#hasArg()">hasArg</a>, <a href="AbstractOption.html#hasArgs()">hasArgs</a>, <a href="AbstractOption.html#isDeprecated()">isDeprecated</a>, <a href="AbstractOption.html#isRequired()">isRequired</a>, <a href="AbstractOption.html#keyValue()">keyValue</a></code></div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor.detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.commons.cli.Option)">
<h3>AntOption</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">AntOption</span>&#8203;<span class="parameters">(org.apache.commons.cli.Option&nbsp;option)</span></div>
<div class="block">Constructor.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>option</code> - the option to wrap.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method.detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getAntOptions()">
<h3>getAntOptions</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a>&gt;</span>&nbsp;<span class="element-name">getAntOptions</span>()</div>
<div class="block">Gets the list of all available Ant options.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the list of all available Ant options.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getUnsupportedOptions()">
<h3>getUnsupportedOptions</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;org.apache.commons.cli.Option&gt;</span>&nbsp;<span class="element-name">getUnsupportedOptions</span>()</div>
<div class="block">Gets the list of unsupported options.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the list of unsupported options.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getFilteredOptions()">
<h3>getFilteredOptions</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;org.apache.commons.cli.Option&gt;</span>&nbsp;<span class="element-name">getFilteredOptions</span>()</div>
<div class="block">Gets the set of options that are not supported by Ant either by not being supported or
by being converted to another argument.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The set of options that are not supported by Ant.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getRenameMap()">
<h3>getRenameMap</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getRenameMap</span>()</div>
</section>
</li>
<li>
<section class="detail" id="createName(org.apache.commons.cli.Option)">
<h3>createName</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">createName</span>&#8203;<span class="parameters">(org.apache.commons.cli.Option&nbsp;option)</span></div>
</section>
</li>
<li>
<section class="detail" id="isAttribute()">
<h3>isAttribute</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isAttribute</span>()</div>
<div class="block">Returns <code>true</code> if the option should be an attribute of the &lt;rat:report&gt; element.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if the option should be an attribute of the &lt;rat:report&gt; element.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isElement()">
<h3>isElement</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isElement</span>()</div>
<div class="block">Returns <code>true</code> if the option should be a child element of the &lt;rat:report&gt; element.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if the option should be a child element of the &lt;rat:report&gt; element.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getActualAntOption()">
<h3>getActualAntOption</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AntOption.html" title="class in org.apache.rat.documentation.options">AntOption</a></span>&nbsp;<span class="element-name">getActualAntOption</span>()</div>
<div class="block">If this option is converted to another option return that option otherwise
return this option.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the converted option.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="convertedFrom()">
<h3>convertedFrom</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;org.apache.commons.cli.Option&gt;</span>&nbsp;<span class="element-name">convertedFrom</span>()</div>
<div class="block">Gets the set of options that are mapped to this option.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the set of options that are mapped to this option.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getText()">
<h3>getText</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getText</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="AbstractOption.html#getText()">AbstractOption</a></code></span></div>
<div class="block">return a string showing long and short options if they are available. Will return
a string.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="AbstractOption.html#getText()">getText</a></code>&nbsp;in class&nbsp;<code><a href="AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></code></dd>
<dt>Returns:</dt>
<dd>A string showing long and short options if they are available. Never <code>null</code>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="cleanupName(org.apache.commons.cli.Option)">
<h3>cleanupName</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">cleanupName</span>&#8203;<span class="parameters">(org.apache.commons.cli.Option&nbsp;option)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="AbstractOption.html#cleanupName(org.apache.commons.cli.Option)">AbstractOption</a></code></span></div>
<div class="block">Provide means to wrap the given option depending on the UI-specific option implementation.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="AbstractOption.html#cleanupName(org.apache.commons.cli.Option)">cleanupName</a></code>&nbsp;in class&nbsp;<code><a href="AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></code></dd>
<dt>Parameters:</dt>
<dd><code>option</code> - The CLI option</dd>
<dt>Returns:</dt>
<dd>the cleaned up option name.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getComment(boolean)">
<h3>getComment</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getComment</span>&#8203;<span class="parameters">(boolean&nbsp;addParam)</span></div>
<div class="block">Get the method comment for this option.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>addParam</code> - if <code>true</code> the param annotation is added.</dd>
<dt>Returns:</dt>
<dd>the Comment block for the function.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAttributeFunctionName()">
<h3>getAttributeFunctionName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getAttributeFunctionName</span>()</div>
<div class="block">Get the signature of the attribute function.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the signature of the attribute function.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getExample()">
<h3>getExample</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getExample</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="AbstractOption.html#getExample()">AbstractOption</a></code></span></div>
<div class="block">Gets an example of how to use this option in the native UI.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="AbstractOption.html#getExample()">getExample</a></code>&nbsp;in class&nbsp;<code><a href="AbstractOption.html" title="class in org.apache.rat.documentation.options">AbstractOption</a></code></dd>
<dt>Returns:</dt>
<dd>An example of how to use this option in the native UI.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2006&#x2013;2025 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>