/usr/share/doc/libpirl-java/api/PIRL/Utilities/ByteBuffer_InputStream.html is in libpirl-java-doc 2.3.8-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 | <!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 Tue Nov 20 23:14:35 UTC 2012 -->
<title>ByteBuffer_InputStream</title>
<meta name="date" content="2012-11-20">
<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="ByteBuffer_InputStream";
}
//-->
</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="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="../../PIRL/Utilities/Authentication.html" title="class in PIRL.Utilities"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/Utilities/ByteBuffer_OutputStream.html" title="class in PIRL.Utilities"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/Utilities/ByteBuffer_InputStream.html" target="_top">Frames</a></li>
<li><a href="ByteBuffer_InputStream.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">PIRL.Utilities</div>
<h2 title="Class ByteBuffer_InputStream" class="title">Class ByteBuffer_InputStream</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream</a></li>
<li>
<ul class="inheritance">
<li>PIRL.Utilities.ByteBuffer_InputStream</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="/usr/share/doc/default-jdk-doc/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ByteBuffer_InputStream</span>
extends <a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></pre>
<div class="block">A <i>ByteBuffer_InputStream</i> presents a ByteBuffer as an InputStream.
<p>
This class is thread safe: Methods that might modify the backing
ByteBuffer are synchronized on the ByteBuffer.
<p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="/usr/share/doc/default-jdk-doc/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio"><code>ByteBuffer</code></a>,
<a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#ID">ID</a></strong></code>
<div class="block">Class identification name with source code version and date.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#ByteBuffer_InputStream(java.nio.ByteBuffer)">ByteBuffer_InputStream</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> source)</code>
<div class="block">Construct a ByteBuffer_InputStream on a ByteBuffer.</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>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#available()">available</a></strong>()</code>
<div class="block">Get the number of bytes remaining in the source.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#mark(int)">mark</a></strong>(int read_limit)</code>
<div class="block">Sets a mark at the current input position.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#markSupported()">markSupported</a></strong>()</code>
<div class="block">Test if stream <a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#mark(int)"><code>mark</code></a> and <a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#reset()"><code>reset</code></a> are
supported.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#read()">read</a></strong>()</code>
<div class="block">Get the next datum from the source.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#read(byte[])">read</a></strong>(byte[] byte_array)</code>
<div class="block">Get some number of bytes from the source and store them into a
byte array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#read(byte[], int, int)">read</a></strong>(byte[] byte_array,
int offset,
int length)</code>
<div class="block">Get some number of bytes from the source and store them into a
byte array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#reset()">reset</a></strong>()</code>
<div class="block">Reset the <a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()"><code>source</code></a> position to the most recent
<a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#mark(int)"><code>mark</code></a> position.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#skip(long)">skip</a></strong>(long amount)</code>
<div class="block">Skip over some number of input bytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()">Source</a></strong>()</code>
<div class="block">Get the ByteBuffer backing this ByteBuffer_InputStream.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">
<!-- -->
</a>
<h3>Methods inherited from class java.io.<a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#close()" title="class or interface in java.io">close</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ID">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ID</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ID</pre>
<div class="block">Class identification name with source code version and date.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Utilities.ByteBuffer_InputStream.ID">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ByteBuffer_InputStream(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ByteBuffer_InputStream</h4>
<pre>public ByteBuffer_InputStream(<a href="/usr/share/doc/default-jdk-doc/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> source)</pre>
<div class="block">Construct a ByteBuffer_InputStream on a ByteBuffer.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - The ByteBuffer to be used as the source of input data.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="Source()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Source</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> Source()</pre>
<div class="block">Get the ByteBuffer backing this ByteBuffer_InputStream.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The ByteBuffer backing this ByteBuffer_InputStream.</dd></dl>
</li>
</ul>
<a name="available()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>available</h4>
<pre>public int available()</pre>
<div class="block">Get the number of bytes remaining in the source.
<p></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#available()" title="class or interface in java.io">available</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The number of bytes remaining in the <a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()"><code>source</code></a>.
This is the difference between the buffer's current input
<a href="/usr/share/doc/default-jdk-doc/api/java/nio/Buffer.html?is-external=true#position()" title="class or interface in java.nio"><code>position</code></a> and the input <a href="/usr/share/doc/default-jdk-doc/api/java/nio/Buffer.html?is-external=true#limit()" title="class or interface in java.nio"><code>limit</code></a>. Note that the limit may be less than the
buffer <a href="/usr/share/doc/default-jdk-doc/api/java/nio/Buffer.html?is-external=true#capacity()" title="class or interface in java.nio"><code>capacity</code></a>.</dd></dl>
</li>
</ul>
<a name="mark(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mark</h4>
<pre>public void mark(int read_limit)</pre>
<div class="block">Sets a mark at the current input position.
<p>
The operation is synchronized on the source buffer.
<p></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#mark(int)" title="class or interface in java.io">mark</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>read_limit</code> - Ignored: The read limit is always the
<a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()"><code>source</code></a> limit.</dd></dl>
</li>
</ul>
<a name="markSupported()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>markSupported</h4>
<pre>public boolean markSupported()</pre>
<div class="block">Test if stream <a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#mark(int)"><code>mark</code></a> and <a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#reset()"><code>reset</code></a> are
supported.
<p></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#markSupported()" title="class or interface in java.io">markSupported</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>Always returns true.</dd></dl>
</li>
</ul>
<a name="read()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public int read()</pre>
<div class="block">Get the next datum from the source.
<p>
The operation is synchronized on the source buffer.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#read()" title="class or interface in java.io">read</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The value of the next <a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()"><code>source</code></a> byte (0-255) at
the current buffer position, or -1 if the <a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()"><code>source</code></a>
position is at its <a href="/usr/share/doc/default-jdk-doc/api/java/nio/Buffer.html?is-external=true#limit()" title="class or interface in java.nio"><code>limit</code></a>.</dd></dl>
</li>
</ul>
<a name="read(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public int read(byte[] byte_array)</pre>
<div class="block">Get some number of bytes from the source and store them into a
byte array.
<p>
This method simply returns
<code>read (byte_array, 0, byte_array.length)</code>.
<p></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#read(byte[])" title="class or interface in java.io">read</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>byte_array</code> - A byte[] array where the source data is to be
stored.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The number of bytes read into the array, or -1 if the
<a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()"><code>source</code></a> position is at its <a href="/usr/share/doc/default-jdk-doc/api/java/nio/Buffer.html?is-external=true#limit()" title="class or interface in java.nio"><code>limit</code></a>.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If the byte array is null.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#read(byte[], int, int)"><code>read(byte[], int, int)</code></a></dd></dl>
</li>
</ul>
<a name="read(byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public int read(byte[] byte_array,
int offset,
int length)</pre>
<div class="block">Get some number of bytes from the source and store them into a
byte array.
<p>
If the length to read is less than or equal to zero, zero is
returned. Otherwise the effective length is the lesser of the
length and the amount of data <a href="/usr/share/doc/default-jdk-doc/api/java/nio/Buffer.html?is-external=true#remaining()" title="class or interface in java.nio"><code>remaining</code></a> in the <a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()"><code>source</code></a> buffer.
<p>
The operation is synchronized on the source buffer.
<p></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#read(byte[], int, int)" title="class or interface in java.io">read</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>byte_array</code> - A byte[] array where the source data is to be
stored.</dd><dd><code>offset</code> - The index of the array where the first byte will be
stored.</dd><dd><code>length</code> - The maximum number of bytes to transfer from the
<a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()"><code>source</code></a> to the array.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The number of bytes read into the array, or -1 if the
<a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()"><code>source</code></a> position is at its <a href="/usr/share/doc/default-jdk-doc/api/java/nio/Buffer.html?is-external=true#limit()" title="class or interface in java.nio"><code>limit</code></a>.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If the byte array is null.</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - If the offset is negative or
the offset plus the effective length is greater than the
remaining space in the array.</dd></dl>
</li>
</ul>
<a name="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public void reset()
throws <a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Reset the <a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()"><code>source</code></a> position to the most recent
<a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#mark(int)"><code>mark</code></a> position.
<p>
The operation is synchronized on the source buffer.
<p></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#reset()" title="class or interface in java.io">reset</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If no mark has been set.</dd></dl>
</li>
</ul>
<a name="skip(long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>skip</h4>
<pre>public long skip(long amount)</pre>
<div class="block">Skip over some number of input bytes.
<p>
The <a href="../../PIRL/Utilities/ByteBuffer_InputStream.html#Source()"><code>source</code></a> input position is moved to its
current position plus the lesser of the amount specified or
the amount available data <a href="/usr/share/doc/default-jdk-doc/api/java/nio/Buffer.html?is-external=true#remaining()" title="class or interface in java.nio"><code>remaining</code></a>
in the buffer.
<p>
The operation is synchronized on the source buffer.
<p></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true#skip(long)" title="class or interface in java.io">skip</a></code> in class <code><a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - The amount of data to skip.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The number of data bytes skipped.</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="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="../../PIRL/Utilities/Authentication.html" title="class in PIRL.Utilities"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/Utilities/ByteBuffer_OutputStream.html" title="class in PIRL.Utilities"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/Utilities/ByteBuffer_InputStream.html" target="_top">Frames</a></li>
<li><a href="ByteBuffer_InputStream.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|