UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

432 lines (431 loc) 19.5 kB
<!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_67) on Sun Sep 07 15:29:32 CEST 2014 --> <title>DataOutputStreamPlus (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"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="DataOutputStreamPlus (apache-cassandra API)"; } //--> </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/DataOutputStreamPlus.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/cassandra/io/util/DataOutputStreamAndChannel.html" title="class in org.apache.cassandra.io.util"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html" title="class in org.apache.cassandra.io.util"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/io/util/DataOutputStreamPlus.html" target="_top">Frames</a></li> <li><a href="DataOutputStreamPlus.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.cassandra.io.util</div> <h2 title="Class DataOutputStreamPlus" class="title">Class DataOutputStreamPlus</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>java.io.OutputStream</li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html" title="class in org.apache.cassandra.io.util">org.apache.cassandra.io.util.AbstractDataOutput</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.io.util.DataOutputStreamPlus</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.DataOutput, java.io.Flushable, java.lang.AutoCloseable, <a href="../../../../../org/apache/cassandra/io/util/DataOutputPlus.html" title="interface in org.apache.cassandra.io.util">DataOutputPlus</a></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../../org/apache/cassandra/io/util/DataOutputBuffer.html" title="class in org.apache.cassandra.io.util">DataOutputBuffer</a>, <a href="../../../../../org/apache/cassandra/io/util/DataOutputStreamAndChannel.html" title="class in org.apache.cassandra.io.util">DataOutputStreamAndChannel</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">DataOutputStreamPlus</span> extends <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html" title="class in org.apache.cassandra.io.util">AbstractDataOutput</a> implements <a href="../../../../../org/apache/cassandra/io/util/DataOutputPlus.html" title="interface in org.apache.cassandra.io.util">DataOutputPlus</a></pre> <div class="block">When possible use <a href="../../../../../org/apache/cassandra/io/util/DataOutputStreamAndChannel.html" title="class in org.apache.cassandra.io.util"><code>DataOutputStreamAndChannel</code></a> instead of this class, as it will be more efficient. This class is only for situations where it cannot be used</div> </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">&nbsp;</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>protected java.io.OutputStream</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/DataOutputStreamPlus.html#out">out</a></strong></code>&nbsp;</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">&nbsp;</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/io/util/DataOutputStreamPlus.html#DataOutputStreamPlus(java.io.OutputStream)">DataOutputStreamPlus</a></strong>(java.io.OutputStream&nbsp;out)</code>&nbsp;</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">&nbsp;</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>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/DataOutputStreamPlus.html#close()">close</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/DataOutputStreamPlus.html#flush()">flush</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/DataOutputStreamPlus.html#write(byte[],%20int,%20int)">write</a></strong>(byte[]&nbsp;buffer, int&nbsp;offset, int&nbsp;count)</code> <div class="block">Writes <code>count</code> bytes from the byte array <code>buffer</code> starting at <code>offset</code> to this RandomAccessFile starting at the current file pointer..</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/DataOutputStreamPlus.html#write(int)">write</a></strong>(int&nbsp;oneByte)</code> <div class="block">Writes the specified byte <code>oneByte</code> to this RandomAccessFile starting at the current file pointer.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.io.util.AbstractDataOutput"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.io.util.<a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html" title="class in org.apache.cassandra.io.util">AbstractDataOutput</a></h3> <code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#write(byte[])">write</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#write(java.nio.ByteBuffer)">write</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#write(org.apache.cassandra.io.util.Memory)">write</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#writeBoolean(boolean)">writeBoolean</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#writeByte(int)">writeByte</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#writeBytes(java.lang.String)">writeBytes</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#writeChar(int)">writeChar</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#writeChars(java.lang.String)">writeChars</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#writeDouble(double)">writeDouble</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#writeFloat(float)">writeFloat</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#writeInt(int)">writeInt</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#writeLong(long)">writeLong</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#writeShort(int)">writeShort</a>, <a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#writeUTF(java.lang.String)">writeUTF</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&nbsp;java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.io.util.DataOutputPlus"> <!-- --> </a> <h3>Methods inherited from interface&nbsp;org.apache.cassandra.io.util.<a href="../../../../../org/apache/cassandra/io/util/DataOutputPlus.html" title="interface in org.apache.cassandra.io.util">DataOutputPlus</a></h3> <code><a href="../../../../../org/apache/cassandra/io/util/DataOutputPlus.html#write(java.nio.ByteBuffer)">write</a>, <a href="../../../../../org/apache/cassandra/io/util/DataOutputPlus.html#write(org.apache.cassandra.io.util.Memory)">write</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.io.DataOutput"> <!-- --> </a> <h3>Methods inherited from interface&nbsp;java.io.DataOutput</h3> <code>write, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF</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="out"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>out</h4> <pre>protected final&nbsp;java.io.OutputStream out</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="DataOutputStreamPlus(java.io.OutputStream)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>DataOutputStreamPlus</h4> <pre>public&nbsp;DataOutputStreamPlus(java.io.OutputStream&nbsp;out)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="write(byte[], int, int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>write</h4> <pre>public&nbsp;void&nbsp;write(byte[]&nbsp;buffer, int&nbsp;offset, int&nbsp;count) throws java.io.IOException</pre> <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#write(byte[],%20int,%20int)">AbstractDataOutput</a></code></strong></div> <div class="block">Writes <code>count</code> bytes from the byte array <code>buffer</code> starting at <code>offset</code> to this RandomAccessFile starting at the current file pointer..</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>write</code>&nbsp;in interface&nbsp;<code>java.io.DataOutput</code></dd> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#write(byte[],%20int,%20int)">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html" title="class in org.apache.cassandra.io.util">AbstractDataOutput</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - the bytes to be written</dd><dd><code>offset</code> - offset in buffer to get bytes</dd><dd><code>count</code> - number of bytes in buffer to write</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code> - If an error occurs attempting to write to this RandomAccessFile.</dd></dl> </li> </ul> <a name="write(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>write</h4> <pre>public&nbsp;void&nbsp;write(int&nbsp;oneByte) throws java.io.IOException</pre> <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#write(int)">AbstractDataOutput</a></code></strong></div> <div class="block">Writes the specified byte <code>oneByte</code> to this RandomAccessFile starting at the current file pointer. Only the low order byte of <code>oneByte</code> is written.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>write</code>&nbsp;in interface&nbsp;<code>java.io.DataOutput</code></dd> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html#write(int)">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cassandra/io/util/AbstractDataOutput.html" title="class in org.apache.cassandra.io.util">AbstractDataOutput</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>oneByte</code> - the byte to be written</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code> - If an error occurs attempting to write to this RandomAccessFile.</dd></dl> </li> </ul> <a name="close()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>close</h4> <pre>public&nbsp;void&nbsp;close() throws java.io.IOException</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd> <dt><strong>Specified by:</strong></dt> <dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd> <dt><strong>Overrides:</strong></dt> <dd><code>close</code>&nbsp;in class&nbsp;<code>java.io.OutputStream</code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="flush()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>flush</h4> <pre>public&nbsp;void&nbsp;flush() throws java.io.IOException</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>flush</code>&nbsp;in interface&nbsp;<code>java.io.Flushable</code></dd> <dt><strong>Overrides:</strong></dt> <dd><code>flush</code>&nbsp;in class&nbsp;<code>java.io.OutputStream</code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../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/DataOutputStreamPlus.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/cassandra/io/util/DataOutputStreamAndChannel.html" title="class in org.apache.cassandra.io.util"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html" title="class in org.apache.cassandra.io.util"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/io/util/DataOutputStreamPlus.html" target="_top">Frames</a></li> <li><a href="DataOutputStreamPlus.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &copy; 2014 The Apache Software Foundation</small></p> </body> </html>