/usr/share/doc/libplexus-utils2-java/api/org/codehaus/plexus/util/DirectoryScanner.html is in libplexus-utils2-java-doc 3.0.22-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 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 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DirectoryScanner (Plexus Common Utilities 3.0.22 API)</title>
<meta name="date" content="2015-11-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DirectoryScanner (Plexus Common Utilities 3.0.22 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/DirectoryScanner.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="../../../../org/codehaus/plexus/util/CollectionUtils.html" title="class in org.codehaus.plexus.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/codehaus/plexus/util/DirectoryWalker.html" title="class in org.codehaus.plexus.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/codehaus/plexus/util/DirectoryScanner.html" target="_top">Frames</a></li>
<li><a href="DirectoryScanner.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="#field_summary">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><a href="#field_detail">Field</a> | </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">org.codehaus.plexus.util</div>
<h2 title="Class DirectoryScanner" class="title">Class DirectoryScanner</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/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><a href="../../../../org/codehaus/plexus/util/AbstractScanner.html" title="class in org.codehaus.plexus.util">org.codehaus.plexus.util.AbstractScanner</a></li>
<li>
<ul class="inheritance">
<li>org.codehaus.plexus.util.DirectoryScanner</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/codehaus/plexus/util/Scanner.html" title="interface in org.codehaus.plexus.util">Scanner</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">DirectoryScanner</span>
extends <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html" title="class in org.codehaus.plexus.util">AbstractScanner</a></pre>
<div class="block">Class for scanning a directory for files/directories which match certain
criteria.
<p/>
These criteria consist of selectors and patterns which have been specified.
With the selectors you can select which files you want to have included.
Files which are not selected are excluded. With patterns you can include
or exclude files based on their filename.
<p/>
The idea is simple. A given directory is recursively scanned for all files
and directories. Each file/directory is matched against a set of selectors,
including special support for matching against filenames with include and
and exclude patterns. Only files/directories which match at least one
pattern of the include pattern list or other file selector, and don't match
any pattern of the exclude pattern list or fail to match against a required
selector will be placed in the list of files/directories found.
<p/>
When no list of include patterns is supplied, "**" will be used, which
means that everything will be matched. When no list of exclude patterns is
supplied, an empty list is used, such that nothing will be excluded. When
no selectors are supplied, none are applied.
<p/>
The filename pattern matching is done as follows:
The name to be matched is split up in path segments. A path segment is the
name of a directory or file, which is bounded by
<code>File.separator</code> ('/' under UNIX, '\' under Windows).
For example, "abc/def/ghi/xyz.java" is split up in the segments "abc",
"def","ghi" and "xyz.java".
The same is done for the pattern against which should be matched.
<p/>
The segments of the name and the pattern are then matched against each
other. When '**' is used for a path segment in the pattern, it matches
zero or more path segments of the name.
<p/>
There is a special case regarding the use of <code>File.separator</code>s
at the beginning of the pattern and the string to match:<br>
When a pattern starts with a <code>File.separator</code>, the string
to match must also start with a <code>File.separator</code>.
When a pattern does not start with a <code>File.separator</code>, the
string to match may not start with a <code>File.separator</code>.
When one of these rules is not obeyed, the string will not
match.
<p/>
When a name path segment is matched against a pattern path segment, the
following special characters can be used:<br>
'*' matches zero or more characters<br>
'?' matches one character.
<p/>
Examples:
<p/>
"**\*.class" matches all .class files/dirs in a directory tree.
<p/>
"test\a??.java" matches all files/dirs which start with an 'a', then two
more characters and then ".java", in a directory called test.
<p/>
"**" matches everything in a directory tree.
<p/>
"**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where
there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").
<p/>
Case sensitivity may be turned off if necessary. By default, it is
turned on.
<p/>
Example of usage:
<pre>
String[] includes = {"*\*\*.class"};
String[] excludes = {"modules\\\*\**"};
ds.setIncludes(includes);
ds.setExcludes(excludes);
ds.setBasedir(new File("test"));
ds.setCaseSensitive(true);
ds.scan();
System.out.println("FILES:");
String[] files = ds.getIncludedFiles();
for (int i = 0; i < files.length; i++) {
System.out.println(files[i]);
}
</pre>
This will scan a directory called test for .class files, but excludes all
files in all proper subdirectories of a directory called "modules"</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Arnout J. Kuiper
<a href="mailto:ajkuiper@wxs.nl">ajkuiper@wxs.nl</a>, Magesh Umasankar, <a href="mailto:bruce@callenish.com">Bruce Atherton</a>, <a href="mailto:levylambert@tiscali-dsl.de">Antoine Levy-Lambert</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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#basedir">basedir</a></strong></code>
<div class="block">The base directory to be scanned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#dirsDeselected">dirsDeselected</a></strong></code>
<div class="block">The directories which matched at least one include and no excludes
but which a selector discarded.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#dirsExcluded">dirsExcluded</a></strong></code>
<div class="block">The directories which matched at least one include and at least one
exclude.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#dirsIncluded">dirsIncluded</a></strong></code>
<div class="block">The directories which matched at least one include and no excludes
and were selected.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#dirsNotIncluded">dirsNotIncluded</a></strong></code>
<div class="block">The directories which were found and did not match any includes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#everythingIncluded">everythingIncluded</a></strong></code>
<div class="block">Whether or not everything tested so far has been included.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#filesDeselected">filesDeselected</a></strong></code>
<div class="block">The files which matched at least one include and no excludes and
which a selector discarded.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#filesExcluded">filesExcluded</a></strong></code>
<div class="block">The files which matched at least one include and at least
one exclude.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#filesIncluded">filesIncluded</a></strong></code>
<div class="block">The files which matched at least one include and no excludes
and were selected.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#filesNotIncluded">filesNotIncluded</a></strong></code>
<div class="block">The files which did not match any includes or selectors.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#haveSlowResults">haveSlowResults</a></strong></code>
<div class="block">Whether or not our results were built by a slow scan.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.codehaus.plexus.util.AbstractScanner">
<!-- -->
</a>
<h3>Fields inherited from class org.codehaus.plexus.util.<a href="../../../../org/codehaus/plexus/util/AbstractScanner.html" title="class in org.codehaus.plexus.util">AbstractScanner</a></h3>
<code><a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#DEFAULTEXCLUDES">DEFAULTEXCLUDES</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#excludes">excludes</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#includes">includes</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#isCaseSensitive">isCaseSensitive</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" 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><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#DirectoryScanner()">DirectoryScanner</a></strong>()</code>
<div class="block">Sole constructor.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#getBasedir()">getBasedir</a></strong>()</code>
<div class="block">Returns the base directory to be scanned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#getDeselectedDirectories()">getDeselectedDirectories</a></strong>()</code>
<div class="block">Returns the names of the directories which were selected out and
therefore not ultimately included.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#getDeselectedFiles()">getDeselectedFiles</a></strong>()</code>
<div class="block">Returns the names of the files which were selected out and
therefore not ultimately included.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#getExcludedDirectories()">getExcludedDirectories</a></strong>()</code>
<div class="block">Returns the names of the directories which matched at least one of the
include patterns and at least one of the exclude patterns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#getExcludedFiles()">getExcludedFiles</a></strong>()</code>
<div class="block">Returns the names of the files which matched at least one of the
include patterns and at least one of the exclude patterns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#getIncludedDirectories()">getIncludedDirectories</a></strong>()</code>
<div class="block">Returns the names of the directories which matched at least one of the
include patterns and none of the exclude patterns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#getIncludedFiles()">getIncludedFiles</a></strong>()</code>
<div class="block">Returns the names of the files which matched at least one of the
include patterns and none of the exclude patterns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#getNotIncludedDirectories()">getNotIncludedDirectories</a></strong>()</code>
<div class="block">Returns the names of the directories which matched none of the include
patterns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#getNotIncludedFiles()">getNotIncludedFiles</a></strong>()</code>
<div class="block">Returns the names of the files which matched none of the include
patterns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#isEverythingIncluded()">isEverythingIncluded</a></strong>()</code>
<div class="block">Returns whether or not the scanner has included all the files or
directories it has come across so far.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#isParentSymbolicLink(java.io.File,%20java.lang.String)">isParentSymbolicLink</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> parent,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Checks whether the parent of this file is a symbolic link.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#isSelected(java.lang.String,%20java.io.File)">isSelected</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code>
<div class="block">Tests whether a name should be selected.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#isSymbolicLink(java.io.File,%20java.lang.String)">isSymbolicLink</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> parent,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Checks whether a given file is a symbolic link.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#scan()">scan</a></strong>()</code>
<div class="block">Scans the base directory for files which match at least one include
pattern and don't match any exclude patterns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#scandir(java.io.File,%20java.lang.String,%20boolean)">scandir</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> dir,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> vpath,
boolean fast)</code>
<div class="block">Scans the given directory for files and directories.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#setBasedir(java.io.File)">setBasedir</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> basedir)</code>
<div class="block">Sets the base directory to be scanned.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#setBasedir(java.lang.String)">setBasedir</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> basedir)</code>
<div class="block">Sets the base directory to be scanned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#setFollowSymlinks(boolean)">setFollowSymlinks</a></strong>(boolean followSymlinks)</code>
<div class="block">Sets whether or not symbolic links should be followed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#slowScan()">slowScan</a></strong>()</code>
<div class="block">Top level invocation for a slow scan.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.codehaus.plexus.util.AbstractScanner">
<!-- -->
</a>
<h3>Methods inherited from class org.codehaus.plexus.util.<a href="../../../../org/codehaus/plexus/util/AbstractScanner.html" title="class in org.codehaus.plexus.util">AbstractScanner</a></h3>
<code><a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#addDefaultExcludes()">addDefaultExcludes</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#couldHoldIncluded(java.lang.String)">couldHoldIncluded</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#isExcluded(java.lang.String)">isExcluded</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#isExcluded(java.lang.String,%20java.lang.String[])">isExcluded</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#isIncluded(java.lang.String)">isIncluded</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#isIncluded(java.lang.String,%20java.lang.String[])">isIncluded</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#match(java.lang.String,%20java.lang.String)">match</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#match(java.lang.String,%20java.lang.String,%20boolean)">match</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#matchPath(java.lang.String,%20java.lang.String)">matchPath</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#matchPath(java.lang.String,%20java.lang.String,%20boolean)">matchPath</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#matchPatternStart(java.lang.String,%20java.lang.String)">matchPatternStart</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#matchPatternStart(java.lang.String,%20java.lang.String,%20boolean)">matchPatternStart</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#setCaseSensitive(boolean)">setCaseSensitive</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#setExcludes(java.lang.String[])">setExcludes</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#setIncludes(java.lang.String[])">setIncludes</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#setupDefaultFilters()">setupDefaultFilters</a>, <a href="../../../../org/codehaus/plexus/util/AbstractScanner.html#setupMatchPatterns()">setupMatchPatterns</a></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/1.5.0/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/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="basedir">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>basedir</h4>
<pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> basedir</pre>
<div class="block">The base directory to be scanned.</div>
</li>
</ul>
<a name="filesIncluded">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filesIncluded</h4>
<pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> filesIncluded</pre>
<div class="block">The files which matched at least one include and no excludes
and were selected.</div>
</li>
</ul>
<a name="filesNotIncluded">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filesNotIncluded</h4>
<pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> filesNotIncluded</pre>
<div class="block">The files which did not match any includes or selectors.</div>
</li>
</ul>
<a name="filesExcluded">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filesExcluded</h4>
<pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> filesExcluded</pre>
<div class="block">The files which matched at least one include and at least
one exclude.</div>
</li>
</ul>
<a name="dirsIncluded">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dirsIncluded</h4>
<pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> dirsIncluded</pre>
<div class="block">The directories which matched at least one include and no excludes
and were selected.</div>
</li>
</ul>
<a name="dirsNotIncluded">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dirsNotIncluded</h4>
<pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> dirsNotIncluded</pre>
<div class="block">The directories which were found and did not match any includes.</div>
</li>
</ul>
<a name="dirsExcluded">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dirsExcluded</h4>
<pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> dirsExcluded</pre>
<div class="block">The directories which matched at least one include and at least one
exclude.</div>
</li>
</ul>
<a name="filesDeselected">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filesDeselected</h4>
<pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> filesDeselected</pre>
<div class="block">The files which matched at least one include and no excludes and
which a selector discarded.</div>
</li>
</ul>
<a name="dirsDeselected">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dirsDeselected</h4>
<pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> dirsDeselected</pre>
<div class="block">The directories which matched at least one include and no excludes
but which a selector discarded.</div>
</li>
</ul>
<a name="haveSlowResults">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>haveSlowResults</h4>
<pre>protected boolean haveSlowResults</pre>
<div class="block">Whether or not our results were built by a slow scan.</div>
</li>
</ul>
<a name="everythingIncluded">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>everythingIncluded</h4>
<pre>protected boolean everythingIncluded</pre>
<div class="block">Whether or not everything tested so far has been included.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DirectoryScanner()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DirectoryScanner</h4>
<pre>public DirectoryScanner()</pre>
<div class="block">Sole constructor.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setBasedir(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBasedir</h4>
<pre>public void setBasedir(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> basedir)</pre>
<div class="block">Sets the base directory to be scanned. This is the directory which is
scanned recursively. All '/' and '\' characters are replaced by
<code>File.separatorChar</code>, so the separator used need not match
<code>File.separatorChar</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>basedir</code> - The base directory to scan.
Must not be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="setBasedir(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBasedir</h4>
<pre>public void setBasedir(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> basedir)</pre>
<div class="block">Sets the base directory to be scanned. This is the directory which is
scanned recursively.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>basedir</code> - The base directory for scanning.
Should not be <code>null</code>.</dd></dl>
</li>
</ul>
<a name="getBasedir()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBasedir</h4>
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> getBasedir()</pre>
<div class="block">Returns the base directory to be scanned.
This is the directory which is scanned recursively.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the base directory to be scanned</dd></dl>
</li>
</ul>
<a name="setFollowSymlinks(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFollowSymlinks</h4>
<pre>public void setFollowSymlinks(boolean followSymlinks)</pre>
<div class="block">Sets whether or not symbolic links should be followed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>followSymlinks</code> - whether or not symbolic links should be followed</dd></dl>
</li>
</ul>
<a name="isEverythingIncluded()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEverythingIncluded</h4>
<pre>public boolean isEverythingIncluded()</pre>
<div class="block">Returns whether or not the scanner has included all the files or
directories it has come across so far.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if all files and directories which have
been found so far have been included.</dd></dl>
</li>
</ul>
<a name="scan()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scan</h4>
<pre>public void scan()
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></pre>
<div class="block">Scans the base directory for files which match at least one include
pattern and don't match any exclude patterns. If there are selectors
then the files must pass muster there, as well.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the base directory was set
incorrectly (i.e. if it is <code>null</code>, doesn't exist,
or isn't a directory).</dd></dl>
</li>
</ul>
<a name="slowScan()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>slowScan</h4>
<pre>protected void slowScan()</pre>
<div class="block">Top level invocation for a slow scan. A slow scan builds up a full
list of excluded/included files/directories, whereas a fast scan
will only have full results for included files, as it ignores
directories which can't possibly hold any included files/directories.
<p/>
Returns immediately if a slow scan has already been completed.</div>
</li>
</ul>
<a name="scandir(java.io.File, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scandir</h4>
<pre>protected void scandir(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> dir,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> vpath,
boolean fast)</pre>
<div class="block">Scans the given directory for files and directories. Found files and
directories are placed in their respective collections, based on the
matching of includes, excludes, and the selectors. When a directory
is found, it is scanned recursively.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dir</code> - The directory to scan. Must not be <code>null</code>.</dd><dd><code>vpath</code> - The path relative to the base directory (needed to
prevent problems with an absolute path when using
dir). Must not be <code>null</code>.</dd><dd><code>fast</code> - Whether or not this call is part of a fast scan.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#filesIncluded"><code>filesIncluded</code></a>,
<a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#filesNotIncluded"><code>filesNotIncluded</code></a>,
<a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#filesExcluded"><code>filesExcluded</code></a>,
<a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#dirsIncluded"><code>dirsIncluded</code></a>,
<a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#dirsNotIncluded"><code>dirsNotIncluded</code></a>,
<a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#dirsExcluded"><code>dirsExcluded</code></a>,
<a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#slowScan()"><code>slowScan()</code></a></dd></dl>
</li>
</ul>
<a name="isSelected(java.lang.String, java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSelected</h4>
<pre>protected boolean isSelected(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</pre>
<div class="block">Tests whether a name should be selected.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the filename to check for selecting</dd><dd><code>file</code> - the java.io.File object for this filename</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>false</code> when the selectors says that the file
should not be selected, <code>true</code> otherwise.</dd></dl>
</li>
</ul>
<a name="getIncludedFiles()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIncludedFiles</h4>
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getIncludedFiles()</pre>
<div class="block">Returns the names of the files which matched at least one of the
include patterns and none of the exclude patterns.
The names are relative to the base directory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the names of the files which matched at least one of the
include patterns and none of the exclude patterns.</dd></dl>
</li>
</ul>
<a name="getNotIncludedFiles()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNotIncludedFiles</h4>
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getNotIncludedFiles()</pre>
<div class="block">Returns the names of the files which matched none of the include
patterns. The names are relative to the base directory. This involves
performing a slow scan if one has not already been completed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the names of the files which matched none of the include
patterns.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#slowScan()"><code>slowScan()</code></a></dd></dl>
</li>
</ul>
<a name="getExcludedFiles()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExcludedFiles</h4>
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getExcludedFiles()</pre>
<div class="block">Returns the names of the files which matched at least one of the
include patterns and at least one of the exclude patterns.
The names are relative to the base directory. This involves
performing a slow scan if one has not already been completed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the names of the files which matched at least one of the
include patterns and at at least one of the exclude patterns.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#slowScan()"><code>slowScan()</code></a></dd></dl>
</li>
</ul>
<a name="getDeselectedFiles()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeselectedFiles</h4>
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getDeselectedFiles()</pre>
<div class="block"><p>Returns the names of the files which were selected out and
therefore not ultimately included.</p>
<p/>
<p>The names are relative to the base directory. This involves
performing a slow scan if one has not already been completed.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the names of the files which were deselected.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#slowScan()"><code>slowScan()</code></a></dd></dl>
</li>
</ul>
<a name="getIncludedDirectories()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIncludedDirectories</h4>
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getIncludedDirectories()</pre>
<div class="block">Returns the names of the directories which matched at least one of the
include patterns and none of the exclude patterns.
The names are relative to the base directory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the names of the directories which matched at least one of the
include patterns and none of the exclude patterns.</dd></dl>
</li>
</ul>
<a name="getNotIncludedDirectories()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNotIncludedDirectories</h4>
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getNotIncludedDirectories()</pre>
<div class="block">Returns the names of the directories which matched none of the include
patterns. The names are relative to the base directory. This involves
performing a slow scan if one has not already been completed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the names of the directories which matched none of the include
patterns.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#slowScan()"><code>slowScan()</code></a></dd></dl>
</li>
</ul>
<a name="getExcludedDirectories()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExcludedDirectories</h4>
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getExcludedDirectories()</pre>
<div class="block">Returns the names of the directories which matched at least one of the
include patterns and at least one of the exclude patterns.
The names are relative to the base directory. This involves
performing a slow scan if one has not already been completed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the names of the directories which matched at least one of the
include patterns and at least one of the exclude patterns.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#slowScan()"><code>slowScan()</code></a></dd></dl>
</li>
</ul>
<a name="getDeselectedDirectories()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeselectedDirectories</h4>
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getDeselectedDirectories()</pre>
<div class="block"><p>Returns the names of the directories which were selected out and
therefore not ultimately included.</p>
<p/>
<p>The names are relative to the base directory. This involves
performing a slow scan if one has not already been completed.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the names of the directories which were deselected.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/codehaus/plexus/util/DirectoryScanner.html#slowScan()"><code>slowScan()</code></a></dd></dl>
</li>
</ul>
<a name="isSymbolicLink(java.io.File, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSymbolicLink</h4>
<pre>public boolean isSymbolicLink(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> parent,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Checks whether a given file is a symbolic link.
<p/>
<p>It doesn't really test for symbolic links but whether the
canonical and absolute paths of the file are identical - this
may lead to false positives on some platforms.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - the parent directory of the file to test</dd><dd><code>name</code> - the name of the file to test.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if it's a symbolic link</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - .</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.5</dd></dl>
</li>
</ul>
<a name="isParentSymbolicLink(java.io.File, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isParentSymbolicLink</h4>
<pre>public boolean isParentSymbolicLink(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> parent,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Checks whether the parent of this file is a symbolic link.
<p/>
<p> For java versions prior to 7 It doesn't really test for
symbolic links but whether the
canonical and absolute paths of the file are identical - this
may lead to false positives on some platforms.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - the parent directory of the file to test</dd><dd><code>name</code> - the name of the file to test.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if it's a symbolic link</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - .</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.5</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/DirectoryScanner.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="../../../../org/codehaus/plexus/util/CollectionUtils.html" title="class in org.codehaus.plexus.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/codehaus/plexus/util/DirectoryWalker.html" title="class in org.codehaus.plexus.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/codehaus/plexus/util/DirectoryScanner.html" target="_top">Frames</a></li>
<li><a href="DirectoryScanner.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="#field_summary">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><a href="#field_detail">Field</a> | </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 © 2015. All rights reserved.</small></p>
</body>
</html>
|