/usr/share/doc/libargs4j-java/api/org/kohsuke/args4j/package-summary.html is in libargs4j-java-doc 2.33-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.kohsuke.args4j (args4j parent 2.33 API)</title>
<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="org.kohsuke.args4j (args4j parent 2.33 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>Prev Package</li>
<li><a href="../../../org/kohsuke/args4j/spi/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/args4j/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package org.kohsuke.args4j</h1>
<div class="docSummary">
<div class="block">Core classes of the Args4J command line parser.</div>
</div>
<p>See: <a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/Localizable.html" title="interface in org.kohsuke.args4j">Localizable</a></td>
<td class="colLast">
<div class="block">A message that can be formatted with arguments and locale.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/OptionHandlerFilter.html" title="interface in org.kohsuke.args4j">OptionHandlerFilter</a></td>
<td class="colLast">
<div class="block">Selects <a href="../../../org/kohsuke/args4j/spi/OptionHandler.html" title="class in org.kohsuke.args4j.spi"><code>OptionHandler</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/OptionHandlerRegistry.OptionHandlerFactory.html" title="interface in org.kohsuke.args4j">OptionHandlerRegistry.OptionHandlerFactory</a></td>
<td class="colLast">
<div class="block">Provide custom logic for creating <a href="../../../org/kohsuke/args4j/spi/OptionHandler.html" title="class in org.kohsuke.args4j.spi"><code>OptionHandler</code></a> implementation.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/ClassParser.html" title="class in org.kohsuke.args4j">ClassParser</a></td>
<td class="colLast">
<div class="block">Parser for analyzing Args4J annotations in the class hierarchy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/CmdLineParser.html" title="class in org.kohsuke.args4j">CmdLineParser</a></td>
<td class="colLast">
<div class="block">Command line argument owner.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/Config.html" title="class in org.kohsuke.args4j">Config</a></td>
<td class="colLast">
<div class="block">Metadataconfiguration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/FieldParser.html" title="class in org.kohsuke.args4j">FieldParser</a></td>
<td class="colLast">
<div class="block">This metadata parser makes all field available to the CmdLineParser.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/NamedOptionDef.html" title="class in org.kohsuke.args4j">NamedOptionDef</a></td>
<td class="colLast">
<div class="block">Immutable run-time copy of <a href="../../../org/kohsuke/args4j/Option.html" title="annotation in org.kohsuke.args4j"><code>Option</code></a> annotation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/OptionDef.html" title="class in org.kohsuke.args4j">OptionDef</a></td>
<td class="colLast">
<div class="block">Run-time copy of the Option or Argument annotation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/OptionHandlerRegistry.html" title="class in org.kohsuke.args4j">OptionHandlerRegistry</a></td>
<td class="colLast">
<div class="block">Manages the registration of option handlers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/ParserProperties.html" title="class in org.kohsuke.args4j">ParserProperties</a></td>
<td class="colLast">
<div class="block">Set of properties that controls <a href="../../../org/kohsuke/args4j/CmdLineParser.html" title="class in org.kohsuke.args4j"><code>CmdLineParser</code></a> behaviours.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/Starter.html" title="class in org.kohsuke.args4j">Starter</a></td>
<td class="colLast">
<div class="block">Starter class which uses reflection to instantiate the business
class, parse the command line parameters, sets the fields of the
business class and doing the help message handling.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/XmlParser.html" title="class in org.kohsuke.args4j">XmlParser</a></td>
<td class="colLast">
<div class="block">Parses an XML-file specifying the 'annotations'.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/ExampleMode.html" title="enum in org.kohsuke.args4j">ExampleMode</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">use <a href="../../../org/kohsuke/args4j/OptionHandlerFilter.html" title="interface in org.kohsuke.args4j"><code>OptionHandlerFilter</code></a></span></div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/CmdLineException.html" title="class in org.kohsuke.args4j">CmdLineException</a></td>
<td class="colLast">
<div class="block">Signals an error in the user input.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Error Summary table, listing errors, and an explanation">
<caption><span>Error Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Error</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/IllegalAnnotationError.html" title="class in org.kohsuke.args4j">IllegalAnnotationError</a></td>
<td class="colLast">
<div class="block">Signals an incorrect use of args4j annotations.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/Argument.html" title="annotation in org.kohsuke.args4j">Argument</a></td>
<td class="colLast">
<div class="block">Argument of the command line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/kohsuke/args4j/Option.html" title="annotation in org.kohsuke.args4j">Option</a></td>
<td class="colLast">
<div class="block">Marks a field/setter that receives a command line switch value.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.kohsuke.args4j Description">Package org.kohsuke.args4j Description</h2>
<div class="block"><p>Core classes of the Args4J command line parser.</p>
<h1>What is Args4J?</h1>
<p>
Args4J is a command line parser.
As such, its job is to parse the String-array passed to the <code>main()</code> method and
transfer the values to a Java object, which includes type conversion.
The entry point into this parsing is the <code>CmdLineParser</code> class,
with its <code>parse()</code> method.
</p>
<p>Args4J must know the mapping between the flag from the command line and the target for the value.
There are many ways to use Args4J:</p>
<ul>
<li>place an <code>@Option</code> or <code>@Argument</code> annotation at a setter or on a field</li>
<li>provide a XML configuration file</li>
<li>make all fields publicly available</li>
</ul>
<p>Depending on what you want, you may have perform a configuration step before parsing.</p>
<h1>Examples</h1>
<p><code>java Main -text newText</code></p>
<p>The typical use involves writing a small bean class and providing the annotations.</p>
<p>This feature is available since the first Args4J release:</p>
<pre>
public class Bean {
@Option(name="-text")
String text;
}
public class Main {
public static void main(String[] args) throws CmdLineException {
Object bean = new Bean();
CmdLineParser parser = new CmdLineParser(bean);
parser.parse(args);
}
}
</pre>
<p>An easy way to initialize fields without touching the bean source code is to use the <code>FieldParser</code>.</p>
<p>The <code>FieldParser</code> scans all fields of bean class (including inheritance), and makes them publicly available as options with a <code>-</code> prefix in the name.</p>
<p>This feature is available since Args4J release 2.0.16:</p>
<code><pre>
public class Bean {
String text;
}
public class Main {
public static void main(String[] args) throws CmdLineException {
Object bean = new Bean();
CmdLineParser parser = new CmdLineParser(null);
new FieldParser().parse(parser, bean);
parser.parse(args);
}
}
</pre></code>
<p>While the <code>FieldParser</code> is easier to use, the <code>XmlParser</code> supports more features.</p>
<p>That said, it supports all features which are available via annotations: usage text, specifying handlers, and more. You have to provide an XML <code>InputSource</code> or a URL to the XML file.</p>
<p>This feature is available since Args4J release 2.0.16:</p>
<code><pre>
public class Bean {
String text;
}
public class Main {
public static void main(String[] args) throws CmdLineException {
Object bean = new Bean();
CmdLineParser parser = new CmdLineParser(null);
new XmlParser().parse(getClass().getResource(bean.getClass().getName() + ".xml"), parser, bean);
parser.parse(args);
}
}
<args>
<option field="text" name="-text" usage="Output text"/>
</args>
</pre></code></div>
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>Prev Package</li>
<li><a href="../../../org/kohsuke/args4j/spi/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/args4j/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2003–2016 <a href="http://www.kohsuke.org/">Kohsuke Kawaguchi</a>. All rights reserved.</small></p>
</body>
</html>
|