/usr/share/doc/libjsap-java/api/com/martiansoftware/jsap/ant/JSAPAntTask.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 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 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 | <!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>JSAPAntTask (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="JSAPAntTask (JSAP 2.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/JSAPAntTask.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="../../../../com/martiansoftware/jsap/ant/FlaggedOptionConfiguration.html" title="class in com.martiansoftware.jsap.ant"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../com/martiansoftware/jsap/ant/OptionConfiguration.html" title="class in com.martiansoftware.jsap.ant"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/martiansoftware/jsap/ant/JSAPAntTask.html" target="_top">Frames</a></li>
<li><a href="JSAPAntTask.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>Nested | </li>
<li><a href="#fields.inherited.from.class.org.apache.tools.ant.Task">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>Field | </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">com.martiansoftware.jsap.ant</div>
<h2 title="Class JSAPAntTask" class="title">Class JSAPAntTask</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://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.tools.ant.ProjectComponent</li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.Task</li>
<li>
<ul class="inheritance">
<li>com.martiansoftware.jsap.ant.JSAPAntTask</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">JSAPAntTask</span>
extends org.apache.tools.ant.Task</pre>
<div class="block"><p>An ANT task that generates a custom subclass of JSAP to simplify its use
in
a program. Rather than create all of the Switches, FlaggedOptions, and
UnflaggedOptions and registering each with the JSAP, the developer does not
need to do anything but instantiate the custom JSAP produced by this task.
</p>
<p>To use this task, you must first declare it in your ANT build file with a
<taskdef> tag, as follows:</p>
<p><code>
<taskdef name="jsap" classname="com.martiansoftware.jsap.ant.JSAPAntTask"
classpath="${lib}/[jsap jarfile]"/>
</code></p>
<p>Note that this <code>taskdef</code> must be placed in your build file
BEFORE your jsap task. The
<code>classpath</code> attribute in the above example assumes that
[jsap jarfile] is the name of the JSAP jarfile you're using, and
is in the directory referenced by the ANT "lib" property.</p>
<p>Once declared, the jsap task can be used as many times as you wish. The
jsap
task supports the following attributes:</p>
<ul>
<li><b>srcdir</b> (required): the source directory below which the generated
JSAP source code should be placed.</li>
<li><b>classname</b> (required): the fully-qualified classname of the JSAP to
generate.</li>
<li><b>public</b> (optional): "true" or "false" (default false). If true,
the
generated class will be declared public.</li>
</ul>
<p>The jsap task supports the following nested elements:</p>
<ul>
<li><b>switch</b> - declares a Switch (com.martiansoftware.jsap.Switch).</li>
<li><b>flaggedoption</b> - declares a FlaggedOption
(com.martiansoftware.jsap.FlaggedOption).</li>
<li><b>unflaggedoption</b> - declares an UnflaggedOption
(com.martiansoftware.jsap.UnflaggedOption).</li>
</ul>
<p>These nested elements support the following attributes:</p>
<center>
<table width="95%" border="1" cellpadding="0" cellspacing="0">
<tr>
<td align="center"><b>Attribute</b></td>
<td align="center"><b>Description</b></td>
<td align="center"><b>switch</b></td>
<td align="center"><b>flaggedoption</b></td>
<td align="center"><b>unflaggedoption</b></td>
<td align="center"><b>qualifiedswitch</b></td>
</tr>
<tr>
<td align="center"><b>id</b></td>
<td align="left">Unique id for this parameter. This must be unique among
all parameters defined in this ANT task.</td>
<td align="center">Required</td>
<td align="center">Required</td>
<td align="center">Required</td>
<td align="center">Required</td>
</tr>
<tr>
<td align="center"><b>shortflag</b></td>
<td align="left">Short flag for this parameter. Only the first character
of this attribute is read by the jsap task. This must be unique among all
short
flags defined in this ANT task.</td>
<td align="left">Either <b>shortflag</b> or <b>longflag</b> is required.
Both may be specified.</td>
<td align="left">Either <b>shortflag</b> or <b>longflag</b> is required.
Both may be specified.</td>
<td align="center">N/A</td>
<td align="left">Either <b>shortflag</b> or <b>longflag</b> is required.
Both may be specified.</td>
</tr>
<tr>
<td align="center"><b>longflag</b></td>
<td align="left">Long flag for this parameter. This must be unique among
all long flags defined in this ANT task.</td>
<td align="left">Either <b>shortflag</b> or <b>longflag</b> is required.
Both may be specified.</td>
<td align="left">Either <b>shortflag</b> or <b>longflag</b> is required.
Both may be specified.</td>
<td align="center">N/A</td>
<td align="left">Either <b>shortflag</b> or <b>longflag</b> is required.
Both may be specified.</td>
</tr>
<tr>
<td align="center"><b>required</b></td>
<td align="left">"true" or "false" (default false). Indicates whether the
specified parameter is required.</td>
<td align="center">N/A</td>
<td align="center">Optional</td>
<td align="center">Optional</td>
<td align="center">Optional</td>
</tr>
<tr>
<td align="center"><b>islist</b></td>
<td align="left">"true" or "false" (default false). Indicates whether the
specified parameter can be supplied as a list of values separated by a
delimiter
character.</td>
<td align="center">N/A</td>
<td align="center">Optional</td>
<td align="center">Optional</td>
<td align="center">Optional</td>
</tr>
<tr>
<td align="center"><b>listseparator</b></td>
<td align="left">Specifies the delimiter character to use for list
parameters.
Default is JSAP.DEFAULT_LISTSEPARATOR</td>
<td align="center">N/A</td>
<td align="center">Optional</td>
<td align="center">Optional</td>
<td align="center">Optional</td>
</tr>
<tr>
<td align="center"><b>stringparser</b></td>
<td align="left">Specifies the subclass of
com.martiansoftware.jsap.StringParser
to be used in parsing this parameter's values. If the specified class name
contains
no "dot" characters, it is assumed to be in the package
com.martiansoftware.jsap.stringparsers.
Default value is
com.martiansoftware.jsap.stringparsers.StringStringParser.</td>
<td align="center">N/A</td>
<td align="center">Optional</td>
<td align="center">Optional</td>
<td align="center">Optional</td>
</tr>
<tr>
<td align="center"><b>greedy</b></td>
<td align="left">"true" or "false" (default false). Specifies whether the
unflaggedoption should be "greedy"; that is, should consume all remaining
unflagged arguments from the command line.</td>
<td align="center">N/A</td>
<td align="center">N/A</td>
<td align="center">Optional</td>
<td align="center">N/A</td>
</tr>
</table>
</center>
<p>All of these nested elements support multiple nested
<code><default></code>
elements. The text content of these tags is used as a default value for the
parameter containing the tag.<p>
<p>Finally, the <flaggedoption> and <unflaggedoption> support
multiple
nested <property> elements, with similar syntax to ANT's
<property>
elements. These properties are set within the parameter's StringParser,
assuming
it is a subclass of com.martiansoftware.jsap.PropertyStringParser.</p>
<h2>Example</h2>
<pre>
& lt;taskdef name = "jsap" classname = "com.martiansoftware.jsap.ant.JSAPAntTask"
classpath="${build}"/>
<target name="createExampleAntJSAP">
<jsap srcdir="${src}"
classname="com.martiansoftware.jsap.examples.ExampleAntJSAP">
<!-- create a switch flagged by "v" or "verbose" -->
<switch id="verbose" shortflag="v" longflag="verbose"/>
<!-- create a required flaggedoption looking for an integer,
flagged by "n" (e.g. "-n 5") -->
<flaggedoption id="num" required="true" shortflag="n"
stringparser="IntegerStringParser">
<default>5</default>
</flaggedoption>
<!-- create an unflaggedoption that reads all of the unflagged
arguments from the
command line -->
<unflaggedoption id="files" greedy="true" />
<!-- create a flaggedoption looking for a Date in "MM/DD/YY"
format, flagged by "d"
or "date", defaulting to Christmas, 2002. -->
<flaggedoption id="date" shortflag="d" longflag="date"
stringparser="DateStringParser">
<property name="format" value="MM/DD/YYYY"/>
<default>12/25/2002</default>
</flaggedoption>
</jsap>
</target>
</pre></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="http://www.martiansoftware.com/contact.html">Marty Lamb</a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/martiansoftware/jsap/JSAP.html" title="class in com.martiansoftware.jsap"><code>JSAP</code></a>,
<a href="../../../../com/martiansoftware/jsap/Parameter.html" title="class in com.martiansoftware.jsap"><code>Parameter</code></a>,
<a href="../../../../com/martiansoftware/jsap/Switch.html" title="class in com.martiansoftware.jsap"><code>Switch</code></a>,
<a href="../../../../com/martiansoftware/jsap/FlaggedOption.html" title="class in com.martiansoftware.jsap"><code>FlaggedOption</code></a>,
<a href="../../../../com/martiansoftware/jsap/UnflaggedOption.html" title="class in com.martiansoftware.jsap"><code>UnflaggedOption</code></a>,
<a href="../../../../com/martiansoftware/jsap/StringParser.html" title="class in com.martiansoftware.jsap"><code>StringParser</code></a>,
<a href="../../../../com/martiansoftware/jsap/PropertyStringParser.html" title="class in com.martiansoftware.jsap"><code>PropertyStringParser</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.tools.ant.Task">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.tools.ant.Task</h3>
<code>target, taskName, taskType, wrapper</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.tools.ant.ProjectComponent">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.tools.ant.ProjectComponent</h3>
<code>description, location, project</code></li>
</ul>
</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="../../../../com/martiansoftware/jsap/ant/JSAPAntTask.html#JSAPAntTask--">JSAPAntTask</a></span>()</code>
<div class="block">Creates a new JSAPAntTask.</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="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></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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/martiansoftware/jsap/ant/JSAPAntTask.html#addConfiguredFlaggedoption-com.martiansoftware.jsap.ant.FlaggedOptionConfiguration-">addConfiguredFlaggedoption</a></span>(<a href="../../../../com/martiansoftware/jsap/ant/FlaggedOptionConfiguration.html" title="class in com.martiansoftware.jsap.ant">FlaggedOptionConfiguration</a> flaggedOptionConfig)</code>
<div class="block">Adds a nested FlaggedOptionConfiguration to the generated JSAP.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/martiansoftware/jsap/ant/JSAPAntTask.html#addConfiguredSwitch-com.martiansoftware.jsap.ant.SwitchConfiguration-">addConfiguredSwitch</a></span>(<a href="../../../../com/martiansoftware/jsap/ant/SwitchConfiguration.html" title="class in com.martiansoftware.jsap.ant">SwitchConfiguration</a> switchConfig)</code>
<div class="block">Adds a nested SwitchConfiguration to the generated JSAP.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/martiansoftware/jsap/ant/JSAPAntTask.html#addConfiguredUnflaggedoption-com.martiansoftware.jsap.ant.UnflaggedOptionConfiguration-">addConfiguredUnflaggedoption</a></span>(<a href="../../../../com/martiansoftware/jsap/ant/UnflaggedOptionConfiguration.html" title="class in com.martiansoftware.jsap.ant">UnflaggedOptionConfiguration</a> unflaggedOptionConfig)</code>
<div class="block">Adds a nested UnflaggedOptionConfiguration to the generated JSAP.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/martiansoftware/jsap/ant/JSAPAntTask.html#execute--">execute</a></span>()</code>
<div class="block">Validates the JSAP configuration and, if successful, writes the java
source code for a JSAP subclass
that implements the configuration specified in the ant build file.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/martiansoftware/jsap/ant/JSAPAntTask.html#setClassname-java.lang.String-">setClassname</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</code>
<div class="block">Sets the full classname for the generated JSAP.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/martiansoftware/jsap/ant/JSAPAntTask.html#setPublic-boolean-">setPublic</a></span>(boolean isPublic)</code>
<div class="block">Sets whether the generated JSAP should be declared public.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/martiansoftware/jsap/ant/JSAPAntTask.html#setSrcdir-java.io.File-">setSrcdir</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> srcDir)</code>
<div class="block">Sets the top-level source directory under which the generated JSAP class
file should be written.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.tools.ant.Task">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.tools.ant.Task</h3>
<code>bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.tools.ant.ProjectComponent">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.tools.ant.ProjectComponent</h3>
<code>clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject</code></li>
</ul>
<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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JSAPAntTask--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JSAPAntTask</h4>
<pre>public JSAPAntTask()</pre>
<div class="block">Creates a new JSAPAntTask. One JSAPAntTask is created for each
<jsap> section in an
ant built file.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setPublic-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPublic</h4>
<pre>public void setPublic(boolean isPublic)</pre>
<div class="block">Sets whether the generated JSAP should be declared public. Default is
false.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>isPublic</code> - if true, the generated JSAP will be declared public.</dd>
</dl>
</li>
</ul>
<a name="setSrcdir-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSrcdir</h4>
<pre>public void setSrcdir(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> srcDir)</pre>
<div class="block">Sets the top-level source directory under which the generated JSAP class
file should be written.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcDir</code> - the top-level source directory under which the generated
JSAP class file should be written.</dd>
</dl>
</li>
</ul>
<a name="setClassname-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClassname</h4>
<pre>public void setClassname(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</pre>
<div class="block">Sets the full classname for the generated JSAP.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>className</code> - the full classname for the generated JSAP.</dd>
</dl>
</li>
</ul>
<a name="addConfiguredFlaggedoption-com.martiansoftware.jsap.ant.FlaggedOptionConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addConfiguredFlaggedoption</h4>
<pre>public void addConfiguredFlaggedoption(<a href="../../../../com/martiansoftware/jsap/ant/FlaggedOptionConfiguration.html" title="class in com.martiansoftware.jsap.ant">FlaggedOptionConfiguration</a> flaggedOptionConfig)</pre>
<div class="block">Adds a nested FlaggedOptionConfiguration to the generated JSAP.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>flaggedOptionConfig</code> - the nested FlaggedOptionConfiguration to add
to the generated JSAP.</dd>
</dl>
</li>
</ul>
<a name="addConfiguredUnflaggedoption-com.martiansoftware.jsap.ant.UnflaggedOptionConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addConfiguredUnflaggedoption</h4>
<pre>public void addConfiguredUnflaggedoption(<a href="../../../../com/martiansoftware/jsap/ant/UnflaggedOptionConfiguration.html" title="class in com.martiansoftware.jsap.ant">UnflaggedOptionConfiguration</a> unflaggedOptionConfig)</pre>
<div class="block">Adds a nested UnflaggedOptionConfiguration to the generated JSAP.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unflaggedOptionConfig</code> - the nested UnflaggedOptionConfiguration to
add to the generated JSAP.</dd>
</dl>
</li>
</ul>
<a name="addConfiguredSwitch-com.martiansoftware.jsap.ant.SwitchConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addConfiguredSwitch</h4>
<pre>public void addConfiguredSwitch(<a href="../../../../com/martiansoftware/jsap/ant/SwitchConfiguration.html" title="class in com.martiansoftware.jsap.ant">SwitchConfiguration</a> switchConfig)</pre>
<div class="block">Adds a nested SwitchConfiguration to the generated JSAP.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>switchConfig</code> - the nested SwitchConfiguration to add to the
generated JSAP.</dd>
</dl>
</li>
</ul>
<a name="execute--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>execute</h4>
<pre>public void execute()
throws org.apache.tools.ant.BuildException</pre>
<div class="block">Validates the JSAP configuration and, if successful, writes the java
source code for a JSAP subclass
that implements the configuration specified in the ant build file.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>execute</code> in class <code>org.apache.tools.ant.Task</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.tools.ant.BuildException</code> - if unsuccessful for any reason.</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/JSAPAntTask.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="../../../../com/martiansoftware/jsap/ant/FlaggedOptionConfiguration.html" title="class in com.martiansoftware.jsap.ant"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../com/martiansoftware/jsap/ant/OptionConfiguration.html" title="class in com.martiansoftware.jsap.ant"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/martiansoftware/jsap/ant/JSAPAntTask.html" target="_top">Frames</a></li>
<li><a href="JSAPAntTask.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>Nested | </li>
<li><a href="#fields.inherited.from.class.org.apache.tools.ant.Task">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>Field | </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>Copyright © 2016. All rights reserved.</small></p>
</body>
</html>
|