UNPKG

cassandra-server

Version:

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

446 lines (445 loc) 17 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:29 CEST 2014 --> <title>ObjectSizes (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="ObjectSizes (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/ObjectSizes.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/utils/Mx4jTool.html" title="class in org.apache.cassandra.utils"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/utils/OutputHandler.html" title="interface in org.apache.cassandra.utils"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/utils/ObjectSizes.html" target="_top">Frames</a></li> <li><a href="ObjectSizes.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>Field&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>Field&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.utils</div> <h2 title="Class ObjectSizes" class="title">Class ObjectSizes</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.utils.ObjectSizes</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">ObjectSizes</span> extends java.lang.Object</pre> <div class="block">A convenience class for wrapping access to MemoryMeter</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== 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/utils/ObjectSizes.html#ObjectSizes()">ObjectSizes</a></strong>()</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>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#measure(java.lang.Object)">measure</a></strong>(java.lang.Object&nbsp;pojo)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#measureDeep(java.lang.Object)">measureDeep</a></strong>(java.lang.Object&nbsp;pojo)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#sizeOf(java.lang.String)">sizeOf</a></strong>(java.lang.String&nbsp;str)</code> <div class="block">Memory a String consumes</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#sizeOfArray(byte[])">sizeOfArray</a></strong>(byte[]&nbsp;bytes)</code> <div class="block">Memory a byte array consumes</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#sizeOfArray(int[])">sizeOfArray</a></strong>(int[]&nbsp;ints)</code> <div class="block">Memory an int array consumes</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#sizeOfArray(long[])">sizeOfArray</a></strong>(long[]&nbsp;longs)</code> <div class="block">Memory a long array consumes</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#sizeOfArray(java.lang.Object[])">sizeOfArray</a></strong>(java.lang.Object[]&nbsp;objects)</code> <div class="block">Memory a reference array consumes itself only</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#sizeOfReferenceArray(int)">sizeOfReferenceArray</a></strong>(int&nbsp;length)</code> <div class="block">Memory a reference array consumes</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#sizeOnHeapExcludingData(java.nio.ByteBuffer)">sizeOnHeapExcludingData</a></strong>(java.nio.ByteBuffer&nbsp;buffer)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#sizeOnHeapExcludingData(java.nio.ByteBuffer[])">sizeOnHeapExcludingData</a></strong>(java.nio.ByteBuffer[]&nbsp;array)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#sizeOnHeapOf(java.nio.ByteBuffer)">sizeOnHeapOf</a></strong>(java.nio.ByteBuffer&nbsp;buffer)</code> <div class="block">Memory a byte buffer consumes</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/ObjectSizes.html#sizeOnHeapOf(java.nio.ByteBuffer[])">sizeOnHeapOf</a></strong>(java.nio.ByteBuffer[]&nbsp;array)</code> <div class="block">Memory a ByteBuffer array consumes.</div> </td> </tr> </table> <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> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="ObjectSizes()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>ObjectSizes</h4> <pre>public&nbsp;ObjectSizes()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="sizeOfArray(byte[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sizeOfArray</h4> <pre>public static&nbsp;long&nbsp;sizeOfArray(byte[]&nbsp;bytes)</pre> <div class="block">Memory a byte array consumes</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - byte array to get memory size</dd> <dt><span class="strong">Returns:</span></dt><dd>heap-size of the array</dd></dl> </li> </ul> <a name="sizeOfArray(long[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sizeOfArray</h4> <pre>public static&nbsp;long&nbsp;sizeOfArray(long[]&nbsp;longs)</pre> <div class="block">Memory a long array consumes</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>longs</code> - byte array to get memory size</dd> <dt><span class="strong">Returns:</span></dt><dd>heap-size of the array</dd></dl> </li> </ul> <a name="sizeOfArray(int[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sizeOfArray</h4> <pre>public static&nbsp;long&nbsp;sizeOfArray(int[]&nbsp;ints)</pre> <div class="block">Memory an int array consumes</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>ints</code> - byte array to get memory size</dd> <dt><span class="strong">Returns:</span></dt><dd>heap-size of the array</dd></dl> </li> </ul> <a name="sizeOfReferenceArray(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sizeOfReferenceArray</h4> <pre>public static&nbsp;long&nbsp;sizeOfReferenceArray(int&nbsp;length)</pre> <div class="block">Memory a reference array consumes</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - the length of the reference array</dd> <dt><span class="strong">Returns:</span></dt><dd>heap-size of the array</dd></dl> </li> </ul> <a name="sizeOfArray(java.lang.Object[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sizeOfArray</h4> <pre>public static&nbsp;long&nbsp;sizeOfArray(java.lang.Object[]&nbsp;objects)</pre> <div class="block">Memory a reference array consumes itself only</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>objects</code> - the array to size</dd> <dt><span class="strong">Returns:</span></dt><dd>heap-size of the array (excluding memory retained by referenced objects)</dd></dl> </li> </ul> <a name="sizeOnHeapOf(java.nio.ByteBuffer[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sizeOnHeapOf</h4> <pre>public static&nbsp;long&nbsp;sizeOnHeapOf(java.nio.ByteBuffer[]&nbsp;array)</pre> <div class="block">Memory a ByteBuffer array consumes.</div> </li> </ul> <a name="sizeOnHeapExcludingData(java.nio.ByteBuffer[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sizeOnHeapExcludingData</h4> <pre>public static&nbsp;long&nbsp;sizeOnHeapExcludingData(java.nio.ByteBuffer[]&nbsp;array)</pre> </li> </ul> <a name="sizeOnHeapOf(java.nio.ByteBuffer)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sizeOnHeapOf</h4> <pre>public static&nbsp;long&nbsp;sizeOnHeapOf(java.nio.ByteBuffer&nbsp;buffer)</pre> <div class="block">Memory a byte buffer consumes</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - ByteBuffer to calculate in memory size</dd> <dt><span class="strong">Returns:</span></dt><dd>Total in-memory size of the byte buffer</dd></dl> </li> </ul> <a name="sizeOnHeapExcludingData(java.nio.ByteBuffer)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sizeOnHeapExcludingData</h4> <pre>public static&nbsp;long&nbsp;sizeOnHeapExcludingData(java.nio.ByteBuffer&nbsp;buffer)</pre> </li> </ul> <a name="sizeOf(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sizeOf</h4> <pre>public static&nbsp;long&nbsp;sizeOf(java.lang.String&nbsp;str)</pre> <div class="block">Memory a String consumes</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>str</code> - String to calculate memory size of</dd> <dt><span class="strong">Returns:</span></dt><dd>Total in-memory size of the String</dd></dl> </li> </ul> <a name="measureDeep(java.lang.Object)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>measureDeep</h4> <pre>public static&nbsp;long&nbsp;measureDeep(java.lang.Object&nbsp;pojo)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pojo</code> - the object to measure</dd> <dt><span class="strong">Returns:</span></dt><dd>the size on the heap of the instance and all retained heap referenced by it, excluding portions of ByteBuffer that are not directly referenced by it but including any other referenced that may also be retained by other objects.</dd></dl> </li> </ul> <a name="measure(java.lang.Object)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>measure</h4> <pre>public static&nbsp;long&nbsp;measure(java.lang.Object&nbsp;pojo)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pojo</code> - the object to measure</dd> <dt><span class="strong">Returns:</span></dt><dd>the size on the heap of the instance only, excluding any referenced objects</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/ObjectSizes.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/utils/Mx4jTool.html" title="class in org.apache.cassandra.utils"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/utils/OutputHandler.html" title="interface in org.apache.cassandra.utils"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/utils/ObjectSizes.html" target="_top">Frames</a></li> <li><a href="ObjectSizes.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>Field&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>Field&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>