/usr/share/doc/libplexus-utils-java/api/org/codehaus/plexus/util/AbstractScanner.html is in libplexus-utils-java-doc 1:1.5.15-4.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Tue Aug 23 19:37:38 UTC 2011 -->
<TITLE>
AbstractScanner (plexus-utils API)
</TITLE>
<META NAME="date" CONTENT="2011-08-23">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractScanner (plexus-utils API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../org/codehaus/plexus/util/Base64.html" title="class in org.codehaus.plexus.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/codehaus/plexus/util/AbstractScanner.html" target="_top"><B>FRAMES</B></A>
<A HREF="AbstractScanner.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.codehaus.plexus.util</FONT>
<BR>
Class AbstractScanner</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.codehaus.plexus.util.AbstractScanner</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/codehaus/plexus/util/Scanner.html" title="interface in org.codehaus.plexus.util">Scanner</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/codehaus/plexus/util/DirectoryScanner.html" title="class in org.codehaus.plexus.util">DirectoryScanner</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>AbstractScanner</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/codehaus/plexus/util/Scanner.html" title="interface in org.codehaus.plexus.util">Scanner</A></DL>
</PRE>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#DEFAULTEXCLUDES">DEFAULTEXCLUDES</A></B></CODE>
<BR>
Patterns which should be excluded by default, like SCM files
Misc: **/*~, **/#*#, **/.#*, **/%*%, **/._*
CVS: **/CVS, **/CVS/**, **/.cvsignore
RCS: **/RCS, **/RCS/**
SCCS: **/SCCS, **/SCCS/**
VSSercer: **/vssver.scc
SVN: **/.svn, **/.svn/**
GNU: **/.arch-ids, **/.arch-ids/**
Bazaar: **/.bzr, **/.bzr/**
SurroundSCM: **/.MySCMServerInfo
Mac: **/.DS_Store
Serena Dimension: **/.metadata, **/.metadata/**
Mercurial: **/.hg, **/.hg/**
GIT: **/.git, **/.git/**
Bitkeeper: **/BitKeeper, **/BitKeeper/**, **/ChangeSet, **/ChangeSet/**
Darcs: **/_darcs, **/_darcs/**, **/.darcsrepo, **/.darcsrepo/****/-darcs-backup*, **/.darcs-temp-mail
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#excludes">excludes</A></B></CODE>
<BR>
The patterns for the files to be excluded.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#includes">includes</A></B></CODE>
<BR>
The patterns for the files to be included.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#isCaseSensitive">isCaseSensitive</A></B></CODE>
<BR>
Whether or not the file system should be treated as a case sensitive
one.</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#AbstractScanner()">AbstractScanner</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#addDefaultExcludes()">addDefaultExcludes</A></B>()</CODE>
<BR>
Adds default exclusions to the current exclusions set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#couldHoldIncluded(java.lang.String)">couldHoldIncluded</A></B>(java.lang.String name)</CODE>
<BR>
Tests whether or not a name matches the start of at least one include
pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#isExcluded(java.lang.String)">isExcluded</A></B>(java.lang.String name)</CODE>
<BR>
Tests whether or not a name matches against at least one exclude
pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#isIncluded(java.lang.String)">isIncluded</A></B>(java.lang.String name)</CODE>
<BR>
Tests whether or not a name matches against at least one include
pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#match(java.lang.String, java.lang.String)">match</A></B>(java.lang.String pattern,
java.lang.String str)</CODE>
<BR>
Tests whether or not a string matches against a pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#match(java.lang.String, java.lang.String, boolean)">match</A></B>(java.lang.String pattern,
java.lang.String str,
boolean isCaseSensitive)</CODE>
<BR>
Tests whether or not a string matches against a pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#matchPath(java.lang.String, java.lang.String)">matchPath</A></B>(java.lang.String pattern,
java.lang.String str)</CODE>
<BR>
Tests whether or not a given path matches a given pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#matchPath(java.lang.String, java.lang.String, boolean)">matchPath</A></B>(java.lang.String pattern,
java.lang.String str,
boolean isCaseSensitive)</CODE>
<BR>
Tests whether or not a given path matches a given pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#matchPatternStart(java.lang.String, java.lang.String)">matchPatternStart</A></B>(java.lang.String pattern,
java.lang.String str)</CODE>
<BR>
Tests whether or not a given path matches the start of a given
pattern up to the first "**".</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#matchPatternStart(java.lang.String, java.lang.String, boolean)">matchPatternStart</A></B>(java.lang.String pattern,
java.lang.String str,
boolean isCaseSensitive)</CODE>
<BR>
Tests whether or not a given path matches the start of a given
pattern up to the first "**".</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#setCaseSensitive(boolean)">setCaseSensitive</A></B>(boolean isCaseSensitive)</CODE>
<BR>
Sets whether or not the file system should be regarded as case sensitive.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#setExcludes(java.lang.String[])">setExcludes</A></B>(java.lang.String[] excludes)</CODE>
<BR>
Sets the list of exclude patterns to use.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#setIncludes(java.lang.String[])">setIncludes</A></B>(java.lang.String[] includes)</CODE>
<BR>
Sets the list of include patterns to use.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#setupDefaultFilters()">setupDefaultFilters</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.codehaus.plexus.util.Scanner"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.codehaus.plexus.util.<A HREF="../../../../org/codehaus/plexus/util/Scanner.html" title="interface in org.codehaus.plexus.util">Scanner</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/codehaus/plexus/util/Scanner.html#getBasedir()">getBasedir</A>, <A HREF="../../../../org/codehaus/plexus/util/Scanner.html#getIncludedDirectories()">getIncludedDirectories</A>, <A HREF="../../../../org/codehaus/plexus/util/Scanner.html#getIncludedFiles()">getIncludedFiles</A>, <A HREF="../../../../org/codehaus/plexus/util/Scanner.html#scan()">scan</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="DEFAULTEXCLUDES"><!-- --></A><H3>
DEFAULTEXCLUDES</H3>
<PRE>
public static final java.lang.String[] <B>DEFAULTEXCLUDES</B></PRE>
<DL>
<DD>Patterns which should be excluded by default, like SCM files
<ul>
<li>Misc: **/*~, **/#*#, **/.#*, **/%*%, **/._* </li>
<li>CVS: **/CVS, **/CVS/**, **/.cvsignore</li>
<li>RCS: **/RCS, **/RCS/**</li>
<li>SCCS: **/SCCS, **/SCCS/**</li>
<li>VSSercer: **/vssver.scc</li>
<li>SVN: **/.svn, **/.svn/**</li>
<li>GNU: **/.arch-ids, **/.arch-ids/**</li>
<li>Bazaar: **/.bzr, **/.bzr/**</li>
<li>SurroundSCM: **/.MySCMServerInfo</li>
<li>Mac: **/.DS_Store</li>
<li>Serena Dimension: **/.metadata, **/.metadata/**</li>
<li>Mercurial: **/.hg, **/.hg/**</li>
<li>GIT: **/.git, **/.git/**</li>
<li>Bitkeeper: **/BitKeeper, **/BitKeeper/**, **/ChangeSet, **/ChangeSet/**</li>
<li>Darcs: **/_darcs, **/_darcs/**, **/.darcsrepo, **/.darcsrepo/****/-darcs-backup*, **/.darcs-temp-mail
</ul>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/codehaus/plexus/util/AbstractScanner.html#addDefaultExcludes()"><CODE>addDefaultExcludes()</CODE></A></DL>
</DL>
<HR>
<A NAME="includes"><!-- --></A><H3>
includes</H3>
<PRE>
protected java.lang.String[] <B>includes</B></PRE>
<DL>
<DD>The patterns for the files to be included.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="excludes"><!-- --></A><H3>
excludes</H3>
<PRE>
protected java.lang.String[] <B>excludes</B></PRE>
<DL>
<DD>The patterns for the files to be excluded.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="isCaseSensitive"><!-- --></A><H3>
isCaseSensitive</H3>
<PRE>
protected boolean <B>isCaseSensitive</B></PRE>
<DL>
<DD>Whether or not the file system should be treated as a case sensitive
one.
<P>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="AbstractScanner()"><!-- --></A><H3>
AbstractScanner</H3>
<PRE>
public <B>AbstractScanner</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="setCaseSensitive(boolean)"><!-- --></A><H3>
setCaseSensitive</H3>
<PRE>
public void <B>setCaseSensitive</B>(boolean isCaseSensitive)</PRE>
<DL>
<DD>Sets whether or not the file system should be regarded as case sensitive.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>isCaseSensitive</CODE> - whether or not the file system should be
regarded as a case sensitive one</DL>
</DD>
</DL>
<HR>
<A NAME="matchPatternStart(java.lang.String, java.lang.String)"><!-- --></A><H3>
matchPatternStart</H3>
<PRE>
protected static boolean <B>matchPatternStart</B>(java.lang.String pattern,
java.lang.String str)</PRE>
<DL>
<DD>Tests whether or not a given path matches the start of a given
pattern up to the first "**".
<p>
This is not a general purpose test and should only be used if you
can live with false positives. For example, <code>pattern=**\a</code>
and <code>str=b</code> will yield <code>true</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - The pattern to match against. Must not be
<code>null</code>.<DD><CODE>str</CODE> - The path to match, as a String. Must not be
<code>null</code>.
<DT><B>Returns:</B><DD>whether or not a given path matches the start of a given
pattern up to the first "**".</DL>
</DD>
</DL>
<HR>
<A NAME="matchPatternStart(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
matchPatternStart</H3>
<PRE>
protected static boolean <B>matchPatternStart</B>(java.lang.String pattern,
java.lang.String str,
boolean isCaseSensitive)</PRE>
<DL>
<DD>Tests whether or not a given path matches the start of a given
pattern up to the first "**".
<p>
This is not a general purpose test and should only be used if you
can live with false positives. For example, <code>pattern=**\a</code>
and <code>str=b</code> will yield <code>true</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - The pattern to match against. Must not be
<code>null</code>.<DD><CODE>str</CODE> - The path to match, as a String. Must not be
<code>null</code>.<DD><CODE>isCaseSensitive</CODE> - Whether or not matching should be performed
case sensitively.
<DT><B>Returns:</B><DD>whether or not a given path matches the start of a given
pattern up to the first "**".</DL>
</DD>
</DL>
<HR>
<A NAME="matchPath(java.lang.String, java.lang.String)"><!-- --></A><H3>
matchPath</H3>
<PRE>
protected static boolean <B>matchPath</B>(java.lang.String pattern,
java.lang.String str)</PRE>
<DL>
<DD>Tests whether or not a given path matches a given pattern.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - The pattern to match against. Must not be
<code>null</code>.<DD><CODE>str</CODE> - The path to match, as a String. Must not be
<code>null</code>.
<DT><B>Returns:</B><DD><code>true</code> if the pattern matches against the string,
or <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="matchPath(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
matchPath</H3>
<PRE>
protected static boolean <B>matchPath</B>(java.lang.String pattern,
java.lang.String str,
boolean isCaseSensitive)</PRE>
<DL>
<DD>Tests whether or not a given path matches a given pattern.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - The pattern to match against. Must not be
<code>null</code>.<DD><CODE>str</CODE> - The path to match, as a String. Must not be
<code>null</code>.<DD><CODE>isCaseSensitive</CODE> - Whether or not matching should be performed
case sensitively.
<DT><B>Returns:</B><DD><code>true</code> if the pattern matches against the string,
or <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="match(java.lang.String, java.lang.String)"><!-- --></A><H3>
match</H3>
<PRE>
public static boolean <B>match</B>(java.lang.String pattern,
java.lang.String str)</PRE>
<DL>
<DD>Tests whether or not a string matches against a pattern.
The pattern may contain two special characters:<br>
'*' means zero or more characters<br>
'?' means one and only one character
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - The pattern to match against.
Must not be <code>null</code>.<DD><CODE>str</CODE> - The string which must be matched against the pattern.
Must not be <code>null</code>.
<DT><B>Returns:</B><DD><code>true</code> if the string matches against the pattern,
or <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="match(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
match</H3>
<PRE>
protected static boolean <B>match</B>(java.lang.String pattern,
java.lang.String str,
boolean isCaseSensitive)</PRE>
<DL>
<DD>Tests whether or not a string matches against a pattern.
The pattern may contain two special characters:<br>
'*' means zero or more characters<br>
'?' means one and only one character
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - The pattern to match against.
Must not be <code>null</code>.<DD><CODE>str</CODE> - The string which must be matched against the pattern.
Must not be <code>null</code>.<DD><CODE>isCaseSensitive</CODE> - Whether or not matching should be performed
case sensitively.
<DT><B>Returns:</B><DD><code>true</code> if the string matches against the pattern,
or <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="setIncludes(java.lang.String[])"><!-- --></A><H3>
setIncludes</H3>
<PRE>
public void <B>setIncludes</B>(java.lang.String[] includes)</PRE>
<DL>
<DD>Sets the list of include patterns to use. All '/' and '\' characters
are replaced by <code>File.separatorChar</code>, so the separator used
need not match <code>File.separatorChar</code>.
<p>
When a pattern ends with a '/' or '\', "**" is appended.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/codehaus/plexus/util/Scanner.html#setIncludes(java.lang.String[])">setIncludes</A></CODE> in interface <CODE><A HREF="../../../../org/codehaus/plexus/util/Scanner.html" title="interface in org.codehaus.plexus.util">Scanner</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>includes</CODE> - A list of include patterns.
May be <code>null</code>, indicating that all files
should be included. If a non-<code>null</code>
list is given, all elements must be
non-<code>null</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="setExcludes(java.lang.String[])"><!-- --></A><H3>
setExcludes</H3>
<PRE>
public void <B>setExcludes</B>(java.lang.String[] excludes)</PRE>
<DL>
<DD>Sets the list of exclude patterns to use. All '/' and '\' characters
are replaced by <code>File.separatorChar</code>, so the separator used
need not match <code>File.separatorChar</code>.
<p>
When a pattern ends with a '/' or '\', "**" is appended.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/codehaus/plexus/util/Scanner.html#setExcludes(java.lang.String[])">setExcludes</A></CODE> in interface <CODE><A HREF="../../../../org/codehaus/plexus/util/Scanner.html" title="interface in org.codehaus.plexus.util">Scanner</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>excludes</CODE> - A list of exclude patterns.
May be <code>null</code>, indicating that no files
should be excluded. If a non-<code>null</code> list is
given, all elements must be non-<code>null</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="isIncluded(java.lang.String)"><!-- --></A><H3>
isIncluded</H3>
<PRE>
protected boolean <B>isIncluded</B>(java.lang.String name)</PRE>
<DL>
<DD>Tests whether or not a name matches against at least one include
pattern.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name to match. Must not be <code>null</code>.
<DT><B>Returns:</B><DD><code>true</code> when the name matches against at least one
include pattern, or <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="couldHoldIncluded(java.lang.String)"><!-- --></A><H3>
couldHoldIncluded</H3>
<PRE>
protected boolean <B>couldHoldIncluded</B>(java.lang.String name)</PRE>
<DL>
<DD>Tests whether or not a name matches the start of at least one include
pattern.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name to match. Must not be <code>null</code>.
<DT><B>Returns:</B><DD><code>true</code> when the name matches against the start of at
least one include pattern, or <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="isExcluded(java.lang.String)"><!-- --></A><H3>
isExcluded</H3>
<PRE>
protected boolean <B>isExcluded</B>(java.lang.String name)</PRE>
<DL>
<DD>Tests whether or not a name matches against at least one exclude
pattern.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name to match. Must not be <code>null</code>.
<DT><B>Returns:</B><DD><code>true</code> when the name matches against at least one
exclude pattern, or <code>false</code> otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="addDefaultExcludes()"><!-- --></A><H3>
addDefaultExcludes</H3>
<PRE>
public void <B>addDefaultExcludes</B>()</PRE>
<DL>
<DD>Adds default exclusions to the current exclusions set.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/codehaus/plexus/util/Scanner.html#addDefaultExcludes()">addDefaultExcludes</A></CODE> in interface <CODE><A HREF="../../../../org/codehaus/plexus/util/Scanner.html" title="interface in org.codehaus.plexus.util">Scanner</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setupDefaultFilters()"><!-- --></A><H3>
setupDefaultFilters</H3>
<PRE>
protected void <B>setupDefaultFilters</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../org/codehaus/plexus/util/Base64.html" title="class in org.codehaus.plexus.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/codehaus/plexus/util/AbstractScanner.html" target="_top"><B>FRAMES</B></A>
<A HREF="AbstractScanner.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|