/usr/share/doc/libcommons-lang3-java/api/org/apache/commons/lang3/text/StrMatcher.html is in libcommons-lang3-java-doc 3.4-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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>StrMatcher (Apache Commons Lang 3.4 API)</title>
<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="StrMatcher (Apache Commons Lang 3.4 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/StrMatcher.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/apache/commons/lang3/text/StrLookup.html" title="class in org.apache.commons.lang3.text"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/lang3/text/StrSubstitutor.html" title="class in org.apache.commons.lang3.text"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/lang3/text/StrMatcher.html" target="_top">Frames</a></li>
<li><a href="StrMatcher.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>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.lang3.text</div>
<h2 title="Class StrMatcher" class="title">Class StrMatcher</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.lang3.text.StrMatcher</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="strong">StrMatcher</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">A matcher class that can be queried to determine if a character array
portion matches.
<p>
This class comes complete with various factory methods.
If these do not suffice, you can subclass and implement your own matcher.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: StrMatcher.java 1436770 2013-01-22 07:09:45Z ggregory $</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#StrMatcher()">StrMatcher</a></strong>()</code>
<div class="block">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>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#charMatcher(char)">charMatcher</a></strong>(char ch)</code>
<div class="block">Constructor that creates a matcher from a character.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#charSetMatcher(char...)">charSetMatcher</a></strong>(char... chars)</code>
<div class="block">Constructor that creates a matcher from a set of characters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#charSetMatcher(java.lang.String)">charSetMatcher</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> chars)</code>
<div class="block">Constructor that creates a matcher from a string representing a set of characters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#commaMatcher()">commaMatcher</a></strong>()</code>
<div class="block">Returns a matcher which matches the comma character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#doubleQuoteMatcher()">doubleQuoteMatcher</a></strong>()</code>
<div class="block">Returns a matcher which matches the double quote character.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#isMatch(char[],%20int)">isMatch</a></strong>(char[] buffer,
int pos)</code>
<div class="block">Returns the number of matching characters, zero for no match.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#isMatch(char[],%20int,%20int,%20int)">isMatch</a></strong>(char[] buffer,
int pos,
int bufferStart,
int bufferEnd)</code>
<div class="block">Returns the number of matching characters, zero for no match.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#noneMatcher()">noneMatcher</a></strong>()</code>
<div class="block">Matches no characters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#quoteMatcher()">quoteMatcher</a></strong>()</code>
<div class="block">Returns a matcher which matches the single or double quote character.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#singleQuoteMatcher()">singleQuoteMatcher</a></strong>()</code>
<div class="block">Returns a matcher which matches the single quote character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#spaceMatcher()">spaceMatcher</a></strong>()</code>
<div class="block">Returns a matcher which matches the space character.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#splitMatcher()">splitMatcher</a></strong>()</code>
<div class="block">Matches the same characters as StringTokenizer,
namely space, tab, newline and formfeed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#stringMatcher(java.lang.String)">stringMatcher</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</code>
<div class="block">Constructor that creates a matcher from a string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#tabMatcher()">tabMatcher</a></strong>()</code>
<div class="block">Returns a matcher which matches the tab character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html#trimMatcher()">trimMatcher</a></strong>()</code>
<div class="block">Matches the String trim() whitespace characters.</div>
</td>
</tr>
</table>
<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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StrMatcher()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StrMatcher</h4>
<pre>protected StrMatcher()</pre>
<div class="block">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="commaMatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commaMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> commaMatcher()</pre>
<div class="block">Returns a matcher which matches the comma character.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a matcher for a comma</dd></dl>
</li>
</ul>
<a name="tabMatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tabMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> tabMatcher()</pre>
<div class="block">Returns a matcher which matches the tab character.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a matcher for a tab</dd></dl>
</li>
</ul>
<a name="spaceMatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spaceMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> spaceMatcher()</pre>
<div class="block">Returns a matcher which matches the space character.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a matcher for a space</dd></dl>
</li>
</ul>
<a name="splitMatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>splitMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> splitMatcher()</pre>
<div class="block">Matches the same characters as StringTokenizer,
namely space, tab, newline and formfeed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the split matcher</dd></dl>
</li>
</ul>
<a name="trimMatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trimMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> trimMatcher()</pre>
<div class="block">Matches the String trim() whitespace characters.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the trim matcher</dd></dl>
</li>
</ul>
<a name="singleQuoteMatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>singleQuoteMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> singleQuoteMatcher()</pre>
<div class="block">Returns a matcher which matches the single quote character.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a matcher for a single quote</dd></dl>
</li>
</ul>
<a name="doubleQuoteMatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doubleQuoteMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> doubleQuoteMatcher()</pre>
<div class="block">Returns a matcher which matches the double quote character.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a matcher for a double quote</dd></dl>
</li>
</ul>
<a name="quoteMatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>quoteMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> quoteMatcher()</pre>
<div class="block">Returns a matcher which matches the single or double quote character.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a matcher for a single or double quote</dd></dl>
</li>
</ul>
<a name="noneMatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>noneMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> noneMatcher()</pre>
<div class="block">Matches no characters.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a matcher that matches nothing</dd></dl>
</li>
</ul>
<a name="charMatcher(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>charMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> charMatcher(char ch)</pre>
<div class="block">Constructor that creates a matcher from a character.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ch</code> - the character to match, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new Matcher for the given char</dd></dl>
</li>
</ul>
<a name="charSetMatcher(char...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>charSetMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> charSetMatcher(char... chars)</pre>
<div class="block">Constructor that creates a matcher from a set of characters.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>chars</code> - the characters to match, null or empty matches nothing</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new matcher for the given char[]</dd></dl>
</li>
</ul>
<a name="charSetMatcher(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>charSetMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> charSetMatcher(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> chars)</pre>
<div class="block">Constructor that creates a matcher from a string representing a set of characters.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>chars</code> - the characters to match, null or empty matches nothing</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new Matcher for the given characters</dd></dl>
</li>
</ul>
<a name="stringMatcher(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stringMatcher</h4>
<pre>public static <a href="../../../../../org/apache/commons/lang3/text/StrMatcher.html" title="class in org.apache.commons.lang3.text">StrMatcher</a> stringMatcher(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</pre>
<div class="block">Constructor that creates a matcher from a string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - the string to match, null or empty matches nothing</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new Matcher for the given String</dd></dl>
</li>
</ul>
<a name="isMatch(char[], int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMatch</h4>
<pre>public abstract int isMatch(char[] buffer,
int pos,
int bufferStart,
int bufferEnd)</pre>
<div class="block">Returns the number of matching characters, zero for no match.
<p>
This method is called to check for a match.
The parameter <code>pos</code> represents the current position to be
checked in the string <code>buffer</code> (a character array which must
not be changed).
The API guarantees that <code>pos</code> is a valid index for <code>buffer</code>.
<p>
The character array may be larger than the active area to be matched.
Only values in the buffer between the specifed indices may be accessed.
<p>
The matching code may check one character or many.
It may check characters preceding <code>pos</code> as well as those
after, so long as no checks exceed the bounds specified.
<p>
It must return zero for no match, or a positive number if a match was found.
The number indicates the number of characters that matched.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - the text content to match against, do not change</dd><dd><code>pos</code> - the starting position for the match, valid for buffer</dd><dd><code>bufferStart</code> - the first active index in the buffer, valid for buffer</dd><dd><code>bufferEnd</code> - the end index (exclusive) of the active buffer, valid for buffer</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of matching characters, zero for no match</dd></dl>
</li>
</ul>
<a name="isMatch(char[], int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isMatch</h4>
<pre>public int isMatch(char[] buffer,
int pos)</pre>
<div class="block">Returns the number of matching characters, zero for no match.
<p>
This method is called to check for a match.
The parameter <code>pos</code> represents the current position to be
checked in the string <code>buffer</code> (a character array which must
not be changed).
The API guarantees that <code>pos</code> is a valid index for <code>buffer</code>.
<p>
The matching code may check one character or many.
It may check characters preceding <code>pos</code> as well as those after.
<p>
It must return zero for no match, or a positive number if a match was found.
The number indicates the number of characters that matched.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - the text content to match against, do not change</dd><dd><code>pos</code> - the starting position for the match, valid for buffer</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of matching characters, zero for no match</dd><dt><span class="strong">Since:</span></dt>
<dd>2.4</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/StrMatcher.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/apache/commons/lang3/text/StrLookup.html" title="class in org.apache.commons.lang3.text"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/lang3/text/StrSubstitutor.html" title="class in org.apache.commons.lang3.text"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/lang3/text/StrMatcher.html" target="_top">Frames</a></li>
<li><a href="StrMatcher.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>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2001–2015. All rights reserved.</small></p>
</body>
</html>
|