/usr/share/doc/libjdom2-java/api/org/jdom2/output/support/Walker.html is in libjdom2-java-doc 2.0.6-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 | <!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_55) on Sat May 24 05:15:00 UTC 2014 -->
<title>Walker (JDOM v2.x)</title>
<meta name="date" content="2014-05-24">
<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="Walker (JDOM v2.x)";
}
//-->
</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/Walker.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>2.x</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/jdom2/output/support/StAXStreamProcessor.html" title="interface in org.jdom2.output.support"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/jdom2/output/support/WalkerNORMALIZE.html" title="class in org.jdom2.output.support"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jdom2/output/support/Walker.html" target="_top">Frames</a></li>
<li><a href="Walker.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">org.jdom2.output.support</div>
<h2 title="Interface Walker" class="title">Interface Walker</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/jdom2/output/support/AbstractFormattedWalker.html" title="class in org.jdom2.output.support">AbstractFormattedWalker</a>, <a href="../../../../org/jdom2/output/support/WalkerNORMALIZE.html" title="class in org.jdom2.output.support">WalkerNORMALIZE</a>, <a href="../../../../org/jdom2/output/support/WalkerPRESERVE.html" title="class in org.jdom2.output.support">WalkerPRESERVE</a>, <a href="../../../../org/jdom2/output/support/WalkerTRIM.html" title="class in org.jdom2.output.support">WalkerTRIM</a>, <a href="../../../../org/jdom2/output/support/WalkerTRIM_FULL_WHITE.html" title="class in org.jdom2.output.support">WalkerTRIM_FULL_WHITE</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Walker</span></pre>
<div class="block">A model for walking the (potentially formatted) content of an Element.
<p>
Implementations of this class restructure the content to a particular format
and expose the restructured content in this 'Walker' which is a loose
equivalent to an iterator.
<p>
The next() method will return a Content instance (perhaps null) if there
is more content. If the returned content is null, then there will be some
formatted characters available in the text() method. These characters may
need to be represented as CDATA (check the isCDATA() method).
<p>
Not all CDATA and Text nodes need to be reformatted, and as a result they
may be returned as their original CDATA or Text instances instead of using
the formatted text() / isCDATA() mechanism.
<p>
The 'Rules' for the walkers are that no padding is done before the
first content step, and no padding is done after the last content step (but
the first/last content items may be trimmed to the correct format).
Any required padding will be done in plain text (not CDATA) content.
Consecutive CDATA sections may be separated by whitespace text for example.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Rolf Lear</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/output/support/Walker.html#hasNext()">hasNext</a></strong>()</code>
<div class="block">Behaves similarly to to a regular Iterator</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/output/support/Walker.html#isAllText()">isAllText</a></strong>()</code>
<div class="block">If all the content in this walker is empty, or if whatever content
is available is Text-like.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/output/support/Walker.html#isAllWhitespace()">isAllWhitespace</a></strong>()</code>
<div class="block">If all the content is Text-like (<a href="../../../../org/jdom2/output/support/Walker.html#isAllText()"><code>isAllText()</code></a> returns true), and
additionally that any content is either Text or CDATA, and that the
values of these Text/CDATA members are all XML Whitespace.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/output/support/Walker.html#isCDATA()">isCDATA</a></strong>()</code>
<div class="block">If the previous next() method returned null, then this will indicate
whether the current text() value is CDATA or regular Text.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/jdom2/Content.html" title="class in org.jdom2">Content</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/output/support/Walker.html#next()">next</a></strong>()</code>
<div class="block">Similar to an Iterator, but null return values need special treatment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/output/support/Walker.html#text()">text</a></strong>()</code>
<div class="block">If the previous call to next() returned null, then this will return the
required text to be processed.</div>
</td>
</tr>
</table>
</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="isAllText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAllText</h4>
<pre>boolean isAllText()</pre>
<div class="block">If all the content in this walker is empty, or if whatever content
is available is Text-like.
<p>
Text-like content is considered to be <a href="../../../../org/jdom2/Text.html" title="class in org.jdom2"><code>Text</code></a>, <a href="../../../../org/jdom2/CDATA.html" title="class in org.jdom2"><code>CDATA</code></a>,
<a href="../../../../org/jdom2/EntityRef.html" title="class in org.jdom2"><code>EntityRef</code></a>, or any (potentially mixed) sequence of these types,
but no other types.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if there is no content, or all content is Text</dd></dl>
</li>
</ul>
<a name="isAllWhitespace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAllWhitespace</h4>
<pre>boolean isAllWhitespace()</pre>
<div class="block">If all the content is Text-like (<a href="../../../../org/jdom2/output/support/Walker.html#isAllText()"><code>isAllText()</code></a> returns true), and
additionally that any content is either Text or CDATA, and that the
values of these Text/CDATA members are all XML Whitespace.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true</dd></dl>
</li>
</ul>
<a name="hasNext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasNext</h4>
<pre>boolean hasNext()</pre>
<div class="block">Behaves similarly to to a regular Iterator</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if there is more content to be processed</dd></dl>
</li>
</ul>
<a name="next()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre><a href="../../../../org/jdom2/Content.html" title="class in org.jdom2">Content</a> next()</pre>
<div class="block">Similar to an Iterator, but null return values need special treatment.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the next content to be processed, perhaps null if the next
content is re-formatted text of some sort (Text / CDATA).</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.util.NoSuchElementException</code> - if there is no further content.</dd></dl>
</li>
</ul>
<a name="text()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>text</h4>
<pre>java.lang.String text()</pre>
<div class="block">If the previous call to next() returned null, then this will return the
required text to be processed. Check to see whether this text is CDATA
by calling the isCDATA() method.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current text value (null if the previous invocation of next()
returned a non-null value).</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if there was not previous call to next()</dd></dl>
</li>
</ul>
<a name="isCDATA()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isCDATA</h4>
<pre>boolean isCDATA()</pre>
<div class="block">If the previous next() method returned null, then this will indicate
whether the current text() value is CDATA or regular Text.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the current text() is valid, and is CDATA.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if there was not previous call to next()</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/Walker.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>2.x</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/jdom2/output/support/StAXStreamProcessor.html" title="interface in org.jdom2.output.support"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/jdom2/output/support/WalkerNORMALIZE.html" title="class in org.jdom2.output.support"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jdom2/output/support/Walker.html" target="_top">Frames</a></li>
<li><a href="Walker.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>Copyright ? 2014 Jason Hunter, Brett McLaughlin. All Rights Reserved.</small></p>
</body>
</html>
|