cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>EncodedDataInputStream (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <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/EncodedDataInputStream.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>Prev Class</li> <li><a href="../../../../../org/apache/cassandra/utils/vint/EncodedDataOutputStream.html" title="class in org.apache.cassandra.utils.vint"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/utils/vint/EncodedDataInputStream.html" target="_top">Frames</a></li> <li><a href="EncodedDataInputStream.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top">  </a></div>   <div class="header"> <div class="subTitle">org.apache.cassandra.utils.vint</div> <h2 title="Class EncodedDataInputStream" class="title">Class EncodedDataInputStream</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>java.io.InputStream</li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html" title="class in org.apache.cassandra.io.util">org.apache.cassandra.io.util.AbstractDataInput</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.utils.vint.EncodedDataInputStream</li> </ul> </li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.io.Closeable, java.io.DataInput, java.lang.AutoCloseable</dd> </dl> <hr> <br> <pre>public class <span class="strong">EncodedDataInputStream</span> extends <a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html" title="class in org.apache.cassandra.io.util">AbstractDataInput</a></pre> <div class="block">Borrows idea from https://developers.google.com/protocol-buffers/docs/encoding#varints Should be used with EncodedDataOutputStream</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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="../../../../../org/apache/cassandra/utils/vint/EncodedDataInputStream.html#EncodedDataInputStream(java.io.DataInput)">EncodedDataInputStream</a></strong>(java.io.DataInput input)</code> </td> </tr> </table> </li> </ul>  <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>protected int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/vint/EncodedDataInputStream.html#getPosition()">getPosition</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/vint/EncodedDataInputStream.html#read()">read</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/vint/EncodedDataInputStream.html#readInt()">readInt</a></strong>()</code> <div class="block">Reads a 32-bit integer from the current position in this file.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/vint/EncodedDataInputStream.html#readLong()">readLong</a></strong>()</code> <div class="block">Reads a 64-bit long from the current position in this file.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/vint/EncodedDataInputStream.html#readShort()">readShort</a></strong>()</code> <div class="block">Reads a 16-bit short from the current position in this file.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/vint/EncodedDataInputStream.html#readUnsignedShort()">readUnsignedShort</a></strong>()</code> <div class="block">Reads an unsigned 16-bit short from the current position in this file and returns it as an integer.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/vint/EncodedDataInputStream.html#seekInternal(int)">seekInternal</a></strong>(int position)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/vint/EncodedDataInputStream.html#skipBytes(int)">skipBytes</a></strong>(int n)</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.io.util.AbstractDataInput">  </a> <h3>Methods inherited from class org.apache.cassandra.io.util.<a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html" title="class in org.apache.cassandra.io.util">AbstractDataInput</a></h3> <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readBoolean()">readBoolean</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readByte()">readByte</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readChar()">readChar</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readDouble()">readDouble</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readFloat()">readFloat</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readFully(byte[])">readFully</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readFully(byte[],%20int,%20int)">readFully</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readLine()">readLine</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readUnsignedByte()">readUnsignedByte</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readUTF()">readUTF</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream">  </a> <h3>Methods inherited from class java.io.InputStream</h3> <code>available, close, mark, markSupported, read, read, reset, skip</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.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">  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="EncodedDataInputStream(java.io.DataInput)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>EncodedDataInputStream</h4> <pre>public EncodedDataInputStream(java.io.DataInput input)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="skipBytes(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>skipBytes</h4> <pre>public int skipBytes(int n) throws java.io.IOException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="read()">  </a> <ul class="blockList"> <li class="blockList"> <h4>read</h4> <pre>public int read() throws java.io.IOException</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>read</code> in class <code>java.io.InputStream</code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="seekInternal(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>seekInternal</h4> <pre>protected void seekInternal(int position)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#seekInternal(int)">seekInternal</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html" title="class in org.apache.cassandra.io.util">AbstractDataInput</a></code></dd> </dl> </li> </ul> <a name="getPosition()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getPosition</h4> <pre>protected int getPosition()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#getPosition()">getPosition</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html" title="class in org.apache.cassandra.io.util">AbstractDataInput</a></code></dd> </dl> </li> </ul> <a name="readInt()">  </a> <ul class="blockList"> <li class="blockList"> <h4>readInt</h4> <pre>public int readInt() throws java.io.IOException</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readInt()">AbstractDataInput</a></code></strong></div> <div class="block">Reads a 32-bit integer from the current position in this file. Blocks until four bytes have been read, the end of the file is reached or an exception is thrown.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>readInt</code> in interface <code>java.io.DataInput</code></dd> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readInt()">readInt</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html" title="class in org.apache.cassandra.io.util">AbstractDataInput</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>the next int value from this file.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.EOFException</code> - if the end of this file is detected.</dd> <dd><code>java.io.IOException</code> - if this file is closed or another I/O error occurs.</dd></dl> </li> </ul> <a name="readLong()">  </a> <ul class="blockList"> <li class="blockList"> <h4>readLong</h4> <pre>public long readLong() throws java.io.IOException</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readLong()">AbstractDataInput</a></code></strong></div> <div class="block">Reads a 64-bit long from the current position in this file. Blocks until eight bytes have been read, the end of the file is reached or an exception is thrown.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>readLong</code> in interface <code>java.io.DataInput</code></dd> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readLong()">readLong</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html" title="class in org.apache.cassandra.io.util">AbstractDataInput</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>the next long value from this file.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.EOFException</code> - if the end of this file is detected.</dd> <dd><code>java.io.IOException</code> - if this file is closed or another I/O error occurs.</dd></dl> </li> </ul> <a name="readUnsignedShort()">  </a> <ul class="blockList"> <li class="blockList"> <h4>readUnsignedShort</h4> <pre>public int readUnsignedShort() throws java.io.IOException</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readUnsignedShort()">AbstractDataInput</a></code></strong></div> <div class="block">Reads an unsigned 16-bit short from the current position in this file and returns it as an integer. Blocks until two bytes have been read, the end of the file is reached or an exception is thrown.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>readUnsignedShort</code> in interface <code>java.io.DataInput</code></dd> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readUnsignedShort()">readUnsignedShort</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html" title="class in org.apache.cassandra.io.util">AbstractDataInput</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>the next unsigned short value from this file as an int.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.EOFException</code> - if the end of this file is detected.</dd> <dd><code>java.io.IOException</code> - if this file is closed or another I/O error occurs.</dd></dl> </li> </ul> <a name="readShort()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>readShort</h4> <pre>public short readShort() throws java.io.IOException</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readShort()">AbstractDataInput</a></code></strong></div> <div class="block">Reads a 16-bit short from the current position in this file. Blocks until two bytes have been read, the end of the file is reached or an exception is thrown.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>readShort</code> in interface <code>java.io.DataInput</code></dd> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html#readShort()">readShort</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataInput.html" title="class in org.apache.cassandra.io.util">AbstractDataInput</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>the next short value from this file.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.EOFException</code> - if the end of this file is detected.</dd> <dd><code>java.io.IOException</code> - if this file is closed or another I/O error occurs.</dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <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/EncodedDataInputStream.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>Prev Class</li> <li><a href="../../../../../org/apache/cassandra/utils/vint/EncodedDataOutputStream.html" title="class in org.apache.cassandra.utils.vint"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/utils/vint/EncodedDataInputStream.html" target="_top">Frames</a></li> <li><a href="EncodedDataInputStream.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom">  </a></div>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>