| <!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_07) on Tue Oct 02 13:04:16 CEST 2012 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>CompositeByteArrayRelativeWriter (Apache MINA 2.0.6 API)</title> |
| <meta name="date" content="2012-10-02"> |
| <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="CompositeByteArrayRelativeWriter (Apache MINA 2.0.6 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/CompositeByteArrayRelativeWriter.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/mina/util/byteaccess/CompositeByteArrayRelativeReader.html" title="class in org.apache.mina.util.byteaccess"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.ChunkedExpander.html" title="class in org.apache.mina.util.byteaccess"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html" target="_top">Frames</a></li> |
| <li><a href="CompositeByteArrayRelativeWriter.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><a href="#nested_class_summary">Nested</a> | </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.mina.util.byteaccess</div> |
| <h2 title="Class CompositeByteArrayRelativeWriter" class="title">Class CompositeByteArrayRelativeWriter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/1.5.0/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>org.apache.mina.util.byteaccess.CompositeByteArrayRelativeWriter</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">CompositeByteArrayRelativeWriter</span> |
| extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></pre> |
| <div class="block">Provides restricted, relative, write-only access to the bytes in a |
| <code>CompositeByteArray</code>. |
| |
| Using this interface has the advantage that it can be automatically |
| determined when a component <code>ByteArray</code> can no longer be written |
| to, and thus components can be automatically flushed. This makes it easier to |
| use pooling for underlying <code>ByteArray</code>s. |
| |
| By providing an appropriate <code>Expander</code> it is also possible to |
| automatically add more backing storage as more data is written. |
| <br/><br/> |
| TODO: Get flushing working.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd><a href="http://mina.apache.org">Apache MINA Project</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.ChunkedExpander.html" title="class in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.ChunkedExpander</a></strong></code> |
| <div class="block">Expands the supplied <a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArray.html" title="class in org.apache.mina.util.byteaccess"><code>CompositeByteArray</code></a> by the number of |
| bytes provided in the constructor</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Expander.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Expander</a></strong></code> |
| <div class="block">An object that knows how to expand a <code>CompositeByteArray</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Flusher.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Flusher</a></strong></code> |
| <div class="block">An object that knows how to flush a <code>ByteArray</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.NopExpander.html" title="class in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.NopExpander</a></strong></code> |
| <div class="block">No-op expander.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== 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>protected <a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArray.html" title="class in org.apache.mina.util.byteaccess">CompositeByteArray</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#cba">cba</a></strong></code> |
| <div class="block">The underlying <code>CompositeByteArray</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html" title="interface in org.apache.mina.util.byteaccess">ByteArray.Cursor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#cursor">cursor</a></strong></code> |
| <div class="block">A cursor of the underlying <code>CompositeByteArray</code>.</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="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#CompositeByteArrayRelativeWriter(org.apache.mina.util.byteaccess.CompositeByteArray, org.apache.mina.util.byteaccess.CompositeByteArrayRelativeWriter.Expander, org.apache.mina.util.byteaccess.CompositeByteArrayRelativeWriter.Flusher, boolean)">CompositeByteArrayRelativeWriter</a></strong>(<a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArray.html" title="class in org.apache.mina.util.byteaccess">CompositeByteArray</a> cba, |
| <a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Expander.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Expander</a> expander, |
| <a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Flusher.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Flusher</a> flusher, |
| boolean autoFlush)</code> |
| <div class="block">Creates a new instance of CompositeByteArrayRelativeWriter.</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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#append(org.apache.mina.util.byteaccess.ByteArray)">append</a></strong>(<a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess">ByteArray</a> ba)</code> |
| <div class="block">Make a <code>ByteArray</code> available for access at the end of this object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#cursorPassedFirstComponent()">cursorPassedFirstComponent</a></strong>()</code> |
| <div class="block">Called whenever the cursor has passed from the <code>cba</code>'s |
| first component.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#flush()">flush</a></strong>()</code> |
| <div class="block">Flush to the current index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#flushTo(int)">flushTo</a></strong>(int index)</code> |
| <div class="block">Flush to the given index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#free()">free</a></strong>()</code> |
| <div class="block">Free all resources associated with this object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#getIndex()">getIndex</a></strong>()</code> |
| <div class="block">Get the index that will be used for the next access.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#getRemaining()">getRemaining</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#hasRemaining()">hasRemaining</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#last()">last</a></strong>()</code> |
| <div class="block">Get the index after the last byte that can be accessed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#order()">order</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#put(byte)">put</a></strong>(byte b)</code> |
| <div class="block">Puts a <code>byte</code> and advances the reader.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#put(org.apache.mina.core.buffer.IoBuffer)">put</a></strong>(<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> bb)</code> |
| <div class="block">Puts enough bytes to fill the <code>IoBuffer</code> and advances the reader.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putChar(char)">putChar</a></strong>(char c)</code> |
| <div class="block">Puts a <code>char</code> and advances the reader.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putDouble(double)">putDouble</a></strong>(double d)</code> |
| <div class="block">Puts a <code>double</code> and advances the reader.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putFloat(float)">putFloat</a></strong>(float f)</code> |
| <div class="block">Puts a <code>float</code> and advances the reader.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putInt(int)">putInt</a></strong>(int i)</code> |
| <div class="block">Puts an <code>int</code> and advances the reader.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putLong(long)">putLong</a></strong>(long l)</code> |
| <div class="block">Puts a <code>long</code> and advances the reader.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putShort(short)">putShort</a></strong>(short s)</code> |
| <div class="block">Puts a <code>short</code> and advances the reader.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#skip(int)">skip</a></strong>(int length)</code> |
| <div class="block">Advances the writer by the given number of bytes.</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 java.lang.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.5.0/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://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.mina.util.byteaccess.IoRelativeWriter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.mina.util.byteaccess.<a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></h3> |
| <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#getRemaining()">getRemaining</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#hasRemaining()">hasRemaining</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#order()">order</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="cba"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cba</h4> |
| <pre>protected final <a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArray.html" title="class in org.apache.mina.util.byteaccess">CompositeByteArray</a> cba</pre> |
| <div class="block">The underlying <code>CompositeByteArray</code>.</div> |
| </li> |
| </ul> |
| <a name="cursor"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cursor</h4> |
| <pre>protected final <a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html" title="interface in org.apache.mina.util.byteaccess">ByteArray.Cursor</a> cursor</pre> |
| <div class="block">A cursor of the underlying <code>CompositeByteArray</code>. This |
| cursor is never moved directly; its position only changes through calls |
| to relative read or write methods.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CompositeByteArrayRelativeWriter(org.apache.mina.util.byteaccess.CompositeByteArray, org.apache.mina.util.byteaccess.CompositeByteArrayRelativeWriter.Expander, org.apache.mina.util.byteaccess.CompositeByteArrayRelativeWriter.Flusher, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CompositeByteArrayRelativeWriter</h4> |
| <pre>public CompositeByteArrayRelativeWriter(<a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArray.html" title="class in org.apache.mina.util.byteaccess">CompositeByteArray</a> cba, |
| <a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Expander.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Expander</a> expander, |
| <a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Flusher.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Flusher</a> flusher, |
| boolean autoFlush)</pre> |
| <div class="block">Creates a new instance of CompositeByteArrayRelativeWriter.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cba</code> - The CompositeByteArray to use to back this class</dd><dd><code>expander</code> - The expander. Will increase the size of the internal ByteArray</dd><dd><code>flusher</code> - Flushed the ByteArray when necessary</dd><dd><code>autoFlush</code> - Should this class automatically flush?</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="flush()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flush</h4> |
| <pre>public void flush()</pre> |
| <div class="block">Flush to the current index.</div> |
| </li> |
| </ul> |
| <a name="flushTo(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flushTo</h4> |
| <pre>public void flushTo(int index)</pre> |
| <div class="block">Flush to the given index.</div> |
| </li> |
| </ul> |
| <a name="skip(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>skip</h4> |
| <pre>public void skip(int length)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#skip(int)">IoRelativeWriter</a></code></strong></div> |
| <div class="block">Advances the writer by the given number of bytes.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#skip(int)">skip</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cursorPassedFirstComponent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cursorPassedFirstComponent</h4> |
| <pre>protected void cursorPassedFirstComponent()</pre> |
| <div class="block">Called whenever the cursor has passed from the <code>cba</code>'s |
| first component. As the first component is no longer used, this provides |
| a good opportunity for subclasses to perform some action on it (such as |
| freeing it).</div> |
| </li> |
| </ul> |
| <a name="put(byte)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>public void put(byte b)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#put(byte)">IoRelativeWriter</a></code></strong></div> |
| <div class="block">Puts a <code>byte</code> and advances the reader.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#put(byte)">put</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="put(org.apache.mina.core.buffer.IoBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>public void put(<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> bb)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#put(org.apache.mina.core.buffer.IoBuffer)">IoRelativeWriter</a></code></strong></div> |
| <div class="block">Puts enough bytes to fill the <code>IoBuffer</code> and advances the reader.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#put(org.apache.mina.core.buffer.IoBuffer)">put</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putShort(short)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putShort</h4> |
| <pre>public void putShort(short s)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putShort(short)">IoRelativeWriter</a></code></strong></div> |
| <div class="block">Puts a <code>short</code> and advances the reader.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putShort(short)">putShort</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putInt(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putInt</h4> |
| <pre>public void putInt(int i)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putInt(int)">IoRelativeWriter</a></code></strong></div> |
| <div class="block">Puts an <code>int</code> and advances the reader.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putInt(int)">putInt</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putLong(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putLong</h4> |
| <pre>public void putLong(long l)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putLong(long)">IoRelativeWriter</a></code></strong></div> |
| <div class="block">Puts a <code>long</code> and advances the reader.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putLong(long)">putLong</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putFloat(float)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putFloat</h4> |
| <pre>public void putFloat(float f)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putFloat(float)">IoRelativeWriter</a></code></strong></div> |
| <div class="block">Puts a <code>float</code> and advances the reader.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putFloat(float)">putFloat</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putDouble(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putDouble</h4> |
| <pre>public void putDouble(double d)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putDouble(double)">IoRelativeWriter</a></code></strong></div> |
| <div class="block">Puts a <code>double</code> and advances the reader.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putDouble(double)">putDouble</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putChar(char)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putChar</h4> |
| <pre>public void putChar(char c)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putChar(char)">IoRelativeWriter</a></code></strong></div> |
| <div class="block">Puts a <code>char</code> and advances the reader.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putChar(char)">putChar</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRemaining()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemaining</h4> |
| <pre>public final int getRemaining()</pre> |
| </li> |
| </ul> |
| <a name="hasRemaining()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasRemaining</h4> |
| <pre>public final boolean hasRemaining()</pre> |
| </li> |
| </ul> |
| <a name="order()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>order</h4> |
| <pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</a> order()</pre> |
| </li> |
| </ul> |
| <a name="append(org.apache.mina.util.byteaccess.ByteArray)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre>public final void append(<a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess">ByteArray</a> ba)</pre> |
| <div class="block">Make a <code>ByteArray</code> available for access at the end of this object.</div> |
| </li> |
| </ul> |
| <a name="free()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>free</h4> |
| <pre>public final void free()</pre> |
| <div class="block">Free all resources associated with this object.</div> |
| </li> |
| </ul> |
| <a name="getIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndex</h4> |
| <pre>public final int getIndex()</pre> |
| <div class="block">Get the index that will be used for the next access.</div> |
| </li> |
| </ul> |
| <a name="last()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>last</h4> |
| <pre>public final int last()</pre> |
| <div class="block">Get the index after the last byte that can be accessed.</div> |
| </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/CompositeByteArrayRelativeWriter.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/mina/util/byteaccess/CompositeByteArrayRelativeReader.html" title="class in org.apache.mina.util.byteaccess"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.ChunkedExpander.html" title="class in org.apache.mina.util.byteaccess"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html" target="_top">Frames</a></li> |
| <li><a href="CompositeByteArrayRelativeWriter.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><a href="#nested_class_summary">Nested</a> | </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 © 2004-2012 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
