/usr/share/doc/libautomaton-java/api/dk/brics/automaton/AutomatonMatcher.html is in libautomaton-java 1.11-8+dfsg1-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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sun Dec 02 05:10:25 UTC 2012 -->
<title>AutomatonMatcher (dk.brics.automaton)</title>
<meta name="date" content="2012-12-02">
<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="AutomatonMatcher (dk.brics.automaton)";
}
//-->
</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="../../../dk/brics/automaton/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../dk/brics/automaton/Automaton.html" title="class in dk.brics.automaton"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../dk/brics/automaton/AutomatonProvider.html" title="interface in dk.brics.automaton"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?dk/brics/automaton/AutomatonMatcher.html" target="_top">Frames</a></li>
<li><a href="AutomatonMatcher.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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">dk.brics.automaton</div>
<h2 title="Class AutomatonMatcher" class="title">Class AutomatonMatcher</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>dk.brics.automaton.AutomatonMatcher</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.util.regex.MatchResult</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">AutomatonMatcher</span>
extends java.lang.Object
implements java.util.regex.MatchResult</pre>
<div class="block">A tool that performs match operations on a given character sequence using
a compiled automaton.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>John Gibson <<a href="mailto:jgibson@mitre.org">jgibson@mitre.org</a>></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../dk/brics/automaton/RunAutomaton.html#newMatcher(java.lang.CharSequence)"><code>RunAutomaton.newMatcher(java.lang.CharSequence)</code></a>,
<a href="../../../dk/brics/automaton/RunAutomaton.html#newMatcher(java.lang.CharSequence, int, int)"><code>RunAutomaton.newMatcher(java.lang.CharSequence, int, int)</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>int</code></td>
<td class="colLast"><code><strong><a href="../../../dk/brics/automaton/AutomatonMatcher.html#end()">end</a></strong>()</code>
<div class="block">Returns the offset after the last character matched.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../dk/brics/automaton/AutomatonMatcher.html#end(int)">end</a></strong>(int group)</code>
<div class="block">Returns the offset after the last character matched of the specified
capturing group.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../dk/brics/automaton/AutomatonMatcher.html#find()">find</a></strong>()</code>
<div class="block">Find the next matching subsequence of the input.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../dk/brics/automaton/AutomatonMatcher.html#group()">group</a></strong>()</code>
<div class="block">Returns the subsequence of the input found by the previous match.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../dk/brics/automaton/AutomatonMatcher.html#group(int)">group</a></strong>(int group)</code>
<div class="block">Returns the subsequence of the input found by the specified capturing
group during the previous match operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../dk/brics/automaton/AutomatonMatcher.html#groupCount()">groupCount</a></strong>()</code>
<div class="block">Returns the number of capturing groups in the underlying automaton.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../dk/brics/automaton/AutomatonMatcher.html#start()">start</a></strong>()</code>
<div class="block">Returns the offset of the first character matched.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../dk/brics/automaton/AutomatonMatcher.html#start(int)">start</a></strong>(int group)</code>
<div class="block">Returns the offset of the first character matched of the specified
capturing group.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.regex.MatchResult</code></td>
<td class="colLast"><code><strong><a href="../../../dk/brics/automaton/AutomatonMatcher.html#toMatchResult()">toMatchResult</a></strong>()</code>
<div class="block">Returns the current state of this <code>AutomatonMatcher</code> as a
<code>MatchResult</code>.</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="end()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>end</h4>
<pre>public int end()
throws java.lang.IllegalStateException</pre>
<div class="block">Returns the offset after the last character matched.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>end</code> in interface <code>java.util.regex.MatchResult</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The offset after the last character matched.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if there has not been a match attempt or
if the last attempt yielded no results.</dd></dl>
</li>
</ul>
<a name="end(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>end</h4>
<pre>public int end(int group)
throws java.lang.IndexOutOfBoundsException,
java.lang.IllegalStateException</pre>
<div class="block">Returns the offset after the last character matched of the specified
capturing group.
<br />
Note that because the automaton does not support capturing groups the
only valid group is 0 (the entire match).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>end</code> in interface <code>java.util.regex.MatchResult</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - the desired capturing group.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The offset after the last character matched of the specified
capturing group.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if there has not been a match attempt or
if the last attempt yielded no results.</dd>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if the specified capturing group does
not exist in the underlying automaton.</dd></dl>
</li>
</ul>
<a name="find()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>find</h4>
<pre>public boolean find()</pre>
<div class="block">Find the next matching subsequence of the input.
<br />
This also updates the values for the <code>start</code>, <code>end</code>, and
<code>group</code> methods.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if there is a matching subsequence.</dd></dl>
</li>
</ul>
<a name="group()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>group</h4>
<pre>public java.lang.String group()
throws java.lang.IllegalStateException</pre>
<div class="block">Returns the subsequence of the input found by the previous match.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>group</code> in interface <code>java.util.regex.MatchResult</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The subsequence of the input found by the previous match.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if there has not been a match attempt or
if the last attempt yielded no results.</dd></dl>
</li>
</ul>
<a name="group(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>group</h4>
<pre>public java.lang.String group(int group)
throws java.lang.IndexOutOfBoundsException,
java.lang.IllegalStateException</pre>
<div class="block">Returns the subsequence of the input found by the specified capturing
group during the previous match operation.
<br />
Note that because the automaton does not support capturing groups the
only valid group is 0 (the entire match).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>group</code> in interface <code>java.util.regex.MatchResult</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - the desired capturing group.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The subsequence of the input found by the specified capturing
group during the previous match operation the previous match. Or
<code>null</code> if the given group did match.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if there has not been a match attempt or
if the last attempt yielded no results.</dd>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if the specified capturing group does
not exist in the underlying automaton.</dd></dl>
</li>
</ul>
<a name="groupCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupCount</h4>
<pre>public int groupCount()</pre>
<div class="block">Returns the number of capturing groups in the underlying automaton.
<br />
Note that because the automaton does not support capturing groups this
method will always return 0.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>groupCount</code> in interface <code>java.util.regex.MatchResult</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The number of capturing groups in the underlying automaton.</dd></dl>
</li>
</ul>
<a name="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public int start()
throws java.lang.IllegalStateException</pre>
<div class="block">Returns the offset of the first character matched.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>start</code> in interface <code>java.util.regex.MatchResult</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The offset of the first character matched.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if there has not been a match attempt or
if the last attempt yielded no results.</dd></dl>
</li>
</ul>
<a name="start(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public int start(int group)
throws java.lang.IndexOutOfBoundsException,
java.lang.IllegalStateException</pre>
<div class="block">Returns the offset of the first character matched of the specified
capturing group.
<br />
Note that because the automaton does not support capturing groups the
only valid group is 0 (the entire match).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>start</code> in interface <code>java.util.regex.MatchResult</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - the desired capturing group.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The offset of the first character matched of the specified
capturing group.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if there has not been a match attempt or
if the last attempt yielded no results.</dd>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if the specified capturing group does
not exist in the underlying automaton.</dd></dl>
</li>
</ul>
<a name="toMatchResult()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toMatchResult</h4>
<pre>public java.util.regex.MatchResult toMatchResult()</pre>
<div class="block">Returns the current state of this <code>AutomatonMatcher</code> as a
<code>MatchResult</code>.
The result is unaffected by subsequent operations on this object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>MatchResult</code> with the state of this
<code>AutomatonMatcher</code>.</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="../../../dk/brics/automaton/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../dk/brics/automaton/Automaton.html" title="class in dk.brics.automaton"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../dk/brics/automaton/AutomatonProvider.html" title="interface in dk.brics.automaton"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?dk/brics/automaton/AutomatonMatcher.html" target="_top">Frames</a></li>
<li><a href="AutomatonMatcher.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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><i> Copyright © 2001-2011 Anders Møller. </i></small></p>
</body>
</html>
|