Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 2.0.0-M4 / apidocs / org / apache / mina / util / byteaccess / CompositeByteArrayRelativeWriter.html
blob: b3125e1a9dbee9667350dc4fddbe76a07d49ee60 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_191) on Sat Mar 16 19:48:09 CET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CompositeByteArrayRelativeWriter (Apache MINA 2.0.0-M4 API Documentation)</title>
<meta name="date" content="2019-03-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CompositeByteArrayRelativeWriter (Apache MINA 2.0.0-M4 API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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="typeNameLink">Prev&nbsp;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="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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><a href="#nested.class.summary">Nested</a>&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.mina.util.byteaccess</div>
<h2 title="Class CompositeByteArrayRelativeWriter" class="title">Class CompositeByteArrayRelativeWriter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</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="typeNameLabel">CompositeByteArrayRelativeWriter</span>
extends java.lang.Object
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="simpleTagLabel">Version:</span></dt>
<dd>$Rev$, $Date$</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>The Apache MINA Project (dev@mina.apache.org)</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="memberSummary" 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">&nbsp;</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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.ChunkedExpander.html" title="class in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.ChunkedExpander</a></span></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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Expander.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Expander</a></span></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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Flusher.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Flusher</a></span></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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.NopExpander.html" title="class in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.NopExpander</a></span></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="memberSummary" 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 <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><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#cba">cba</a></span></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><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#cursor">cursor</a></span></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="memberSummary" 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><span class="memberNameLink"><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></span>(<a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArray.html" title="class in org.apache.mina.util.byteaccess">CompositeByteArray</a>&nbsp;cba,
<a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Expander.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Expander</a>&nbsp;expander,
<a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Flusher.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Flusher</a>&nbsp;flusher,
boolean&nbsp;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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#append-org.apache.mina.util.byteaccess.ByteArray-">append</a></span>(<a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess">ByteArray</a>&nbsp;ba)</code>
<div class="block">Make a <code>ByteArray</code> available for access at the end of this object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#cursorPassedFirstComponent--">cursorPassedFirstComponent</a></span>()</code>
<div class="block">Called whenever the cursor has passed from the <code>cba</code>'s
first component.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#flush--">flush</a></span>()</code>
<div class="block">Flush to the current index.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#flushTo-int-">flushTo</a></span>(int&nbsp;index)</code>
<div class="block">Flush to the given index.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#free--">free</a></span>()</code>
<div class="block">Free all resources associated with this object.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#getIndex--">getIndex</a></span>()</code>
<div class="block">Get the index that will be used for the next access.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#getRemaining--">getRemaining</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#hasRemaining--">hasRemaining</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#last--">last</a></span>()</code>
<div class="block">Get the index after the last byte that can be accessed.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.nio.ByteOrder</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#order--">order</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#put-byte-">put</a></span>(byte&nbsp;b)</code>
<div class="block">Puts a <code>byte</code> and advances the reader.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#put-org.apache.mina.core.buffer.IoBuffer-">put</a></span>(<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a>&nbsp;bb)</code>
<div class="block">Puts enough bytes to fill the <code>IoBuffer</code> and advances the reader.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putChar-char-">putChar</a></span>(char&nbsp;c)</code>
<div class="block">Puts a <code>char</code> and advances the reader.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putDouble-double-">putDouble</a></span>(double&nbsp;d)</code>
<div class="block">Puts a <code>double</code> and advances the reader.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putFloat-float-">putFloat</a></span>(float&nbsp;f)</code>
<div class="block">Puts a <code>float</code> and advances the reader.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putInt-int-">putInt</a></span>(int&nbsp;i)</code>
<div class="block">Puts an <code>int</code> and advances the reader.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putLong-long-">putLong</a></span>(long&nbsp;l)</code>
<div class="block">Puts a <code>long</code> and advances the reader.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#putShort-short-">putShort</a></span>(short&nbsp;s)</code>
<div class="block">Puts a <code>short</code> and advances the reader.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html#skip-int-">skip</a></span>(int&nbsp;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&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.mina.util.byteaccess.IoRelativeWriter">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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&nbsp;<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&nbsp;<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&nbsp;CompositeByteArrayRelativeWriter(<a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArray.html" title="class in org.apache.mina.util.byteaccess">CompositeByteArray</a>&nbsp;cba,
<a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Expander.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Expander</a>&nbsp;expander,
<a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.Flusher.html" title="interface in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter.Flusher</a>&nbsp;flusher,
boolean&nbsp;autoFlush)</pre>
<div class="block">Creates a new instance of CompositeByteArrayRelativeWriter.</div>
<dl>
<dt><span class="paramLabel">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&nbsp;void&nbsp;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&nbsp;void&nbsp;flushTo(int&nbsp;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&nbsp;void&nbsp;skip(int&nbsp;length)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#skip-int-">IoRelativeWriter</a></code></span></div>
<div class="block">Advances the writer by the given number of bytes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#skip-int-">skip</a></code>&nbsp;in interface&nbsp;<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&nbsp;void&nbsp;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&nbsp;void&nbsp;put(byte&nbsp;b)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#put-byte-">IoRelativeWriter</a></code></span></div>
<div class="block">Puts a <code>byte</code> and advances the reader.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#put-byte-">put</a></code>&nbsp;in interface&nbsp;<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&nbsp;void&nbsp;put(<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a>&nbsp;bb)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#put-org.apache.mina.core.buffer.IoBuffer-">IoRelativeWriter</a></code></span></div>
<div class="block">Puts enough bytes to fill the <code>IoBuffer</code> and advances the reader.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#put-org.apache.mina.core.buffer.IoBuffer-">put</a></code>&nbsp;in interface&nbsp;<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&nbsp;void&nbsp;putShort(short&nbsp;s)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putShort-short-">IoRelativeWriter</a></code></span></div>
<div class="block">Puts a <code>short</code> and advances the reader.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putShort-short-">putShort</a></code>&nbsp;in interface&nbsp;<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&nbsp;void&nbsp;putInt(int&nbsp;i)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putInt-int-">IoRelativeWriter</a></code></span></div>
<div class="block">Puts an <code>int</code> and advances the reader.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putInt-int-">putInt</a></code>&nbsp;in interface&nbsp;<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&nbsp;void&nbsp;putLong(long&nbsp;l)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putLong-long-">IoRelativeWriter</a></code></span></div>
<div class="block">Puts a <code>long</code> and advances the reader.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putLong-long-">putLong</a></code>&nbsp;in interface&nbsp;<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&nbsp;void&nbsp;putFloat(float&nbsp;f)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putFloat-float-">IoRelativeWriter</a></code></span></div>
<div class="block">Puts a <code>float</code> and advances the reader.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putFloat-float-">putFloat</a></code>&nbsp;in interface&nbsp;<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&nbsp;void&nbsp;putDouble(double&nbsp;d)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putDouble-double-">IoRelativeWriter</a></code></span></div>
<div class="block">Puts a <code>double</code> and advances the reader.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putDouble-double-">putDouble</a></code>&nbsp;in interface&nbsp;<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&nbsp;void&nbsp;putChar(char&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putChar-char-">IoRelativeWriter</a></code></span></div>
<div class="block">Puts a <code>char</code> and advances the reader.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putChar-char-">putChar</a></code>&nbsp;in interface&nbsp;<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&nbsp;int&nbsp;getRemaining()</pre>
</li>
</ul>
<a name="hasRemaining--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasRemaining</h4>
<pre>public final&nbsp;boolean&nbsp;hasRemaining()</pre>
</li>
</ul>
<a name="order--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>order</h4>
<pre>public&nbsp;java.nio.ByteOrder&nbsp;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&nbsp;void&nbsp;append(<a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess">ByteArray</a>&nbsp;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&nbsp;void&nbsp;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&nbsp;int&nbsp;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&nbsp;int&nbsp;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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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="typeNameLink">Prev&nbsp;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="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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><a href="#nested.class.summary">Nested</a>&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 &#169; 2004-2019 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p>
</body>
</html>