| <!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 (1.8.0) on Sun Aug 28 20:43:00 EST 2016 --> | |
| <title>LogInputStream (Apache River v3.0.0 API Documentation (internals))</title> | |
| <meta name="date" content="2016-08-28"> | |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> | |
| <script type="text/javascript" src="../../../../script.js"></script> | |
| </head> | |
| <body> | |
| <script type="text/javascript"><!-- | |
| try { | |
| if (location.href.indexOf('is-external=true') == -1) { | |
| parent.document.title="LogInputStream (Apache River v3.0.0 API Documentation (internals))"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; | |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; | |
| var altColor = "altColor"; | |
| var rowColor = "rowColor"; | |
| var tableTab = "tableTab"; | |
| var activeTableTab = "activeTableTab"; | |
| </script> | |
| <noscript> | |
| <div>JavaScript is disabled on your browser.</div> | |
| </noscript> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <div class="topNav"><a name="navbar.top"> | |
| <!-- --> | |
| </a> | |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> | |
| <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/LogInputStream.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/river/reliableLog/LogHandler.html" title="class in org.apache.river.reliableLog"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../org/apache/river/reliableLog/LogOutputStream.html" title="class in org.apache.river.reliableLog"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../index.html?org/apache/river/reliableLog/LogInputStream.html" target="_top">Frames</a></li> | |
| <li><a href="LogInputStream.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">org.apache.river.reliableLog</div> | |
| <h2 title="Class LogInputStream" class="title">Class LogInputStream</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <ul class="inheritance"> | |
| <li><a href="http://docs.oracle.com/javase/6/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><a href="http://docs.oracle.com/javase/6/docs/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>org.apache.river.reliableLog.LogInputStream</li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt>All Implemented Interfaces:</dt> | |
| <dd><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/6/docs/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="typeNameLabel">LogInputStream</span> | |
| extends <a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></pre> | |
| <div class="block">This class extends the functionality of the java.io.InputStream class | |
| in order to provide an input mechanism that can be used by processes | |
| that perform logging operations; in particular, processes that store | |
| state in order to provide persistence.</div> | |
| <dl> | |
| <dt><span class="simpleTagLabel">Author:</span></dt> | |
| <dd>Sun Microsystems, Inc.</dd> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="http://docs.oracle.com/javase/6/docs/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="memberSummary" 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>private <a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/reliableLog/LogInputStream.html#in">in</a></span></code> </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>private int</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/reliableLog/LogInputStream.html#length">length</a></span></code> </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Summary</h3> | |
| <table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/river/reliableLog/LogInputStream.html#LogInputStream-java.io.InputStream-int-">LogInputStream</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in, | |
| int length)</code> | |
| <div class="block">Creates a log input file with the specified input stream.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> | |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Method and Description</th> | |
| </tr> | |
| <tr id="i0" class="altColor"> | |
| <td class="colFirst"><code>int</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/reliableLog/LogInputStream.html#available--">available</a></span>()</code> | |
| <div class="block">Returns the number of bytes that can be read without blocking.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code>private void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/reliableLog/LogInputStream.html#badRead-int-">badRead</a></span>(int numBytes)</code> | |
| <div class="block">Throw exception for reading past end of log record.</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/reliableLog/LogInputStream.html#close--">close</a></span>()</code> | |
| <div class="block">Closes the input stream.</div> | |
| </td> | |
| </tr> | |
| <tr id="i3" class="rowColor"> | |
| <td class="colFirst"><code>protected void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/reliableLog/LogInputStream.html#finalize--">finalize</a></span>()</code> | |
| <div class="block">Closes the stream when garbage is collected.</div> | |
| </td> | |
| </tr> | |
| <tr id="i4" class="altColor"> | |
| <td class="colFirst"><code>int</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/reliableLog/LogInputStream.html#read--">read</a></span>()</code> | |
| <div class="block">Reads a byte of data.</div> | |
| </td> | |
| </tr> | |
| <tr id="i5" class="rowColor"> | |
| <td class="colFirst"><code>int</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/reliableLog/LogInputStream.html#read-byte:A-">read</a></span>(byte[] b)</code> | |
| <div class="block">Reads data into an array of bytes.</div> | |
| </td> | |
| </tr> | |
| <tr id="i6" class="altColor"> | |
| <td class="colFirst"><code>int</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/reliableLog/LogInputStream.html#read-byte:A-int-int-">read</a></span>(byte[] b, | |
| int off, | |
| int len)</code> | |
| <div class="block">Reads data into an array of bytes.</div> | |
| </td> | |
| </tr> | |
| <tr id="i7" class="rowColor"> | |
| <td class="colFirst"><code>long</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/reliableLog/LogInputStream.html#skip-long-">skip</a></span>(long n)</code> | |
| <div class="block">Skips n bytes of input.</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="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></h3> | |
| <code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#mark-int-" title="class or interface in java.io">mark</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#markSupported--" title="class or interface in java.io">markSupported</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#reset--" title="class or interface in java.io">reset</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="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/docs/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="in"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>in</h4> | |
| <pre>private <a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in</pre> | |
| </li> | |
| </ul> | |
| <a name="length"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>length</h4> | |
| <pre>private int length</pre> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Detail</h3> | |
| <a name="LogInputStream-java.io.InputStream-int-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>LogInputStream</h4> | |
| <pre>public LogInputStream(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in, | |
| int length) | |
| throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> | |
| <div class="block">Creates a log input file with the specified input stream.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>in</code> - the input stream</dd> | |
| <dd><code>length</code> - the total number of bytes allowed to be read</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error has occurred.</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="badRead-int-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>badRead</h4> | |
| <pre>private void badRead(int numBytes) | |
| throws <a href="../../../../org/apache/river/reliableLog/LogException.html" title="class in org.apache.river.reliableLog">LogException</a></pre> | |
| <div class="block">Throw exception for reading past end of log record.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>numBytes</code> - number of bytes attempted to be read</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="../../../../org/apache/river/reliableLog/LogException.html" title="class in org.apache.river.reliableLog">LogException</a></code> - Attempt to read past end of log.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="read--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>read</h4> | |
| <pre>public int read() | |
| throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, | |
| <a href="../../../../org/apache/river/reliableLog/LogException.html" title="class in org.apache.river.reliableLog">LogException</a></pre> | |
| <div class="block">Reads a byte of data. This method will block if no input is | |
| available.</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#read--" title="class or interface in java.io">read</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the byte read, or -1 if the end of the stream is reached</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="../../../../org/apache/river/reliableLog/LogException.html" title="class in org.apache.river.reliableLog">LogException</a></code> - Attempt to read past end of log.</dd> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error has occurred.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="read-byte:A-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>read</h4> | |
| <pre>public int read(byte[] b) | |
| throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, | |
| <a href="../../../../org/apache/river/reliableLog/LogException.html" title="class in org.apache.river.reliableLog">LogException</a></pre> | |
| <div class="block">Reads data into an array of bytes. | |
| This method blocks until some input is available.</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#read-byte:A-" title="class or interface in java.io">read</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>b</code> - the buffer into which the data is read</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the actual number of bytes read, -1 is | |
| returned when the end of the stream is reached</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="../../../../org/apache/river/reliableLog/LogException.html" title="class in org.apache.river.reliableLog">LogException</a></code> - Attempt to read past end of log.</dd> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error has occurred.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="read-byte:A-int-int-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>read</h4> | |
| <pre>public int read(byte[] b, | |
| int off, | |
| int len) | |
| throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, | |
| <a href="../../../../org/apache/river/reliableLog/LogException.html" title="class in org.apache.river.reliableLog">LogException</a></pre> | |
| <div class="block">Reads data into an array of bytes. | |
| This method blocks until some input is available.</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#read-byte:A-int-int-" title="class or interface in java.io">read</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>b</code> - the buffer into which the data is read</dd> | |
| <dd><code>off</code> - the start offset of the data</dd> | |
| <dd><code>len</code> - the maximum number of bytes read</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the actual number of bytes read, -1 is | |
| returned when the end of the stream is reached</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="../../../../org/apache/river/reliableLog/LogException.html" title="class in org.apache.river.reliableLog">LogException</a></code> - Attempt to read past end of log.</dd> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error has occurred.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="skip-long-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>skip</h4> | |
| <pre>public long skip(long n) | |
| throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, | |
| <a href="../../../../org/apache/river/reliableLog/LogException.html" title="class in org.apache.river.reliableLog">LogException</a></pre> | |
| <div class="block">Skips n bytes of input.</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/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="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>n</code> - the number of bytes to be skipped</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the actual number of bytes skipped</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="../../../../org/apache/river/reliableLog/LogException.html" title="class in org.apache.river.reliableLog">LogException</a></code> - Attempt to read past end of log.</dd> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error has occurred.</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">Returns the number of bytes that can be read without blocking.</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#available--" title="class or interface in java.io">available</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the number of available bytes, which is initially | |
| equal to the file size</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="close--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>close</h4> | |
| <pre>public void close()</pre> | |
| <div class="block">Closes the input stream. No further input can be read.</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd> | |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> | |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true#close--" title="class or interface in java.io">close</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="finalize--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>finalize</h4> | |
| <pre>protected void finalize() | |
| throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> | |
| <div class="block">Closes the stream when garbage is collected.</div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></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> | |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> | |
| <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/LogInputStream.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/river/reliableLog/LogHandler.html" title="class in org.apache.river.reliableLog"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../org/apache/river/reliableLog/LogOutputStream.html" title="class in org.apache.river.reliableLog"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../index.html?org/apache/river/reliableLog/LogInputStream.html" target="_top">Frames</a></li> | |
| <li><a href="LogInputStream.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 ======= --> | |
| <p class="legalCopy"><small>Copyright 2007-2013, multiple authors.<br>Licensed under the <a href=http://www.apache.org/licenses/LICENSE-2.0 target=child >Apache License, Version 2.0</a>, see the <a href=../../../../doc-files/NOTICE target=child >NOTICE</a> file for attributions.</small></p> | |
| </body> | |
| </html> |