/usr/share/doc/libjsap-java/api/com/martiansoftware/jsap/package-summary.html is in libjsap-java-doc 2.1-3.
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 | <!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>com.martiansoftware.jsap (JSAP 2.1 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="com.martiansoftware.jsap (JSAP 2.1 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="../../../com/martiansoftware/jsap/ant/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/martiansoftware/jsap/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 com.martiansoftware.jsap</h1>
</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="../../../com/martiansoftware/jsap/DefaultSource.html" title="interface in com.martiansoftware.jsap">DefaultSource</a></td>
<td class="colLast">
<div class="block">An interface describing an object as being able to produce a set of default
values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/ExceptionMap.html" title="interface in com.martiansoftware.jsap">ExceptionMap</a></td>
<td class="colLast">
<div class="block">A class for aggregating exceptions thrown by JSAP's parsing process.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/Flagged.html" title="interface in com.martiansoftware.jsap">Flagged</a></td>
<td class="colLast">
<div class="block">Marks an argument as being "flagged" - that is, as having its value on the
command line preceded by an indicator.</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="../../../com/martiansoftware/jsap/CommandLineTokenizer.html" title="class in com.martiansoftware.jsap">CommandLineTokenizer</a></td>
<td class="colLast">
<div class="block">A utility class to parse a command line contained in a single String into
an array of argument tokens, much as the JVM (or more accurately, your
operating system) does before calling your programs' <code>public static
void main(String[] args)</code>
methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/Defaults.html" title="class in com.martiansoftware.jsap">Defaults</a></td>
<td class="colLast">
<div class="block">Stores a collection of default values, associated with their respective
parameters by the parameters' unique IDs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/FlaggedOption.html" title="class in com.martiansoftware.jsap">FlaggedOption</a></td>
<td class="colLast">
<div class="block">An option that implements the Flagged interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/IDMap.html" title="class in com.martiansoftware.jsap">IDMap</a></td>
<td class="colLast">
<div class="block">A utility class to allow lookups of parameter IDs by short flag or long flag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/JSAP.html" title="class in com.martiansoftware.jsap">JSAP</a></td>
<td class="colLast">
<div class="block">The core class of the JSAP (Java Simple Argument Parser) API.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/JSAPResult.html" title="class in com.martiansoftware.jsap">JSAPResult</a></td>
<td class="colLast">
<div class="block">Encapsulates the results of JSAP's parse() methods.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/Option.html" title="class in com.martiansoftware.jsap">Option</a></td>
<td class="colLast">
<div class="block">The base class from which FlaggedOption and UnflaggedOption are derived.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/Parameter.html" title="class in com.martiansoftware.jsap">Parameter</a></td>
<td class="colLast">
<div class="block">Top-level abstraction of a <b>parameter</b>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/PropertyStringParser.html" title="class in com.martiansoftware.jsap">PropertyStringParser</a></td>
<td class="colLast">
<div class="block">A <a href="../../../com/martiansoftware/jsap/StringParser.html" title="class in com.martiansoftware.jsap"><code>StringParser</code></a> subclass that provides a means for setting/getting properties.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/QualifiedSwitch.html" title="class in com.martiansoftware.jsap">QualifiedSwitch</a></td>
<td class="colLast">
<div class="block">A QualifiedSwitch is a parameter that has something in common with a Switch,
i.e., its presence or absence is significant, but different from a "pure"
Switch it can have an additional value (or values) prefixed by a ':' sign
that qualifies the Switch - making it behave like a FlaggedOption if a value
is specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/SimpleJSAP.html" title="class in com.martiansoftware.jsap">SimpleJSAP</a></td>
<td class="colLast">
<div class="block">A simple interface to <a href="../../../com/martiansoftware/jsap/JSAP.html" title="class in com.martiansoftware.jsap"><code>JSAP</code></a> that handles directly help,
explanation and an array of parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/StringParser.html" title="class in com.martiansoftware.jsap">StringParser</a></td>
<td class="colLast">
<div class="block">Class responsible for converting Strings into Objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/Switch.html" title="class in com.martiansoftware.jsap">Switch</a></td>
<td class="colLast">
<div class="block">A Switch is a parameter whose presence alone is significant; another
commonly used term for a Switch is "Flag".</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/UnflaggedOption.html" title="class in com.martiansoftware.jsap">UnflaggedOption</a></td>
<td class="colLast">
<div class="block">An option whose meaning is derived from its <i>position in the argument
list</i> rather than a flag
that precedes it.</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="../../../com/martiansoftware/jsap/IllegalMultipleDeclarationException.html" title="class in com.martiansoftware.jsap">IllegalMultipleDeclarationException</a></td>
<td class="colLast">
<div class="block">An exception indicating that a parameter has illegally been declared multiple
times.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/JSAPException.html" title="class in com.martiansoftware.jsap">JSAPException</a></td>
<td class="colLast">
<div class="block">The base class for all of JSAP's exceptions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/ParseException.html" title="class in com.martiansoftware.jsap">ParseException</a></td>
<td class="colLast">
<div class="block">A JSAPException subclass notifying the application of a parse error.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/RequiredParameterMissingException.html" title="class in com.martiansoftware.jsap">RequiredParameterMissingException</a></td>
<td class="colLast">
<div class="block">An exception indicating that a required parameter was missing from the
supplied arguments and defaults.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/SyntaxException.html" title="class in com.martiansoftware.jsap">SyntaxException</a></td>
<td class="colLast">
<div class="block">An exception indicating that a syntax error was encountered in the argument
list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/UnknownFlagException.html" title="class in com.martiansoftware.jsap">UnknownFlagException</a></td>
<td class="colLast">
<div class="block">An exception indicating that a unknown flag has been specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../com/martiansoftware/jsap/UnspecifiedParameterException.html" title="class in com.martiansoftware.jsap">UnspecifiedParameterException</a></td>
<td class="colLast">
<div class="block">An exception thrown when an argument that requires a conversion
(e.g., an integer) has no associated value, but it is retrieved
by means of a type-specified method (e.g., <a href="../../../com/martiansoftware/jsap/JSAPResult.html#getInt-java.lang.String-"><code>JSAPResult.getInt(String)</code></a>).</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 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="../../../com/martiansoftware/jsap/ant/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/martiansoftware/jsap/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 © 2016. All rights reserved.</small></p>
</body>
</html>
|