blob: 8e274ab7b608b277e629fca811d4c61a275a173a [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 (version 1.7.0_55) on Thu Aug 25 11:37:33 CEST 2016 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>IoRelativeWriter (Apache MINA 2.0.14 API)</title>
<meta name="date" content="2016-08-25">
<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="IoRelativeWriter (Apache MINA 2.0.14 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/IoRelativeWriter.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/IoRelativeReader.html" title="interface in org.apache.mina.util.byteaccess"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/mina/util/byteaccess/SimpleByteArrayFactory.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/IoRelativeWriter.html" target="_top">Frames</a></li>
<li><a href="IoRelativeWriter.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>Constr&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>Constr&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="Interface IoRelativeWriter" class="title">Interface IoRelativeWriter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html" title="interface in org.apache.mina.util.byteaccess">ByteArray.Cursor</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/mina/util/byteaccess/CompositeByteArrayRelativeWriter.html" title="class in org.apache.mina.util.byteaccess">CompositeByteArrayRelativeWriter</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.31">IoRelativeWriter</a></pre>
<div class="block">Provides relative read access to a sequence of bytes.</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">
<!-- ========== 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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#getRemaining()">getRemaining</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#hasRemaining()">hasRemaining</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/IoRelativeWriter.html#order()">order</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#put(byte)">put</a></strong>(byte&nbsp;b)</code>
<div class="block">Puts a <code>byte</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/IoRelativeWriter.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>&nbsp;bb)</code>
<div class="block">Puts enough bytes to fill the <code>IoBuffer</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/IoRelativeWriter.html#putChar(char)">putChar</a></strong>(char&nbsp;c)</code>
<div class="block">Puts a <code>char</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/IoRelativeWriter.html#putDouble(double)">putDouble</a></strong>(double&nbsp;d)</code>
<div class="block">Puts a <code>double</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/IoRelativeWriter.html#putFloat(float)">putFloat</a></strong>(float&nbsp;f)</code>
<div class="block">Puts a <code>float</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/IoRelativeWriter.html#putInt(int)">putInt</a></strong>(int&nbsp;i)</code>
<div class="block">Puts an <code>int</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/IoRelativeWriter.html#putLong(long)">putLong</a></strong>(long&nbsp;l)</code>
<div class="block">Puts a <code>long</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/IoRelativeWriter.html#putShort(short)">putShort</a></strong>(short&nbsp;s)</code>
<div class="block">Puts a <code>short</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/IoRelativeWriter.html#skip(int)">skip</a></strong>(int&nbsp;length)</code>
<div class="block">Advances the writer by the given number of bytes.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRemaining()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemaining</h4>
<pre>int&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.36">getRemaining</a>()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of remaining bytes that can be read.</dd></dl>
</li>
</ul>
<a name="hasRemaining()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasRemaining</h4>
<pre>boolean&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.41">hasRemaining</a>()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>if there are any remaining bytes that can be read.</dd></dl>
</li>
</ul>
<a name="skip(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skip</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.48">skip</a>(int&nbsp;length)</pre>
<div class="block">Advances the writer by the given number of bytes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - The number of bytes to skip</dd></dl>
</li>
</ul>
<a name="order()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>order</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</a>&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.53">order</a>()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the bytes' order</dd></dl>
</li>
</ul>
<a name="put(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.60">put</a>(byte&nbsp;b)</pre>
<div class="block">Puts a <code>byte</code> and advances the reader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - The byte to put</dd></dl>
</li>
</ul>
<a name="put(org.apache.mina.core.buffer.IoBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.67">put</a>(<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">Puts enough bytes to fill the <code>IoBuffer</code> and advances the reader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bb</code> - The bytes to put</dd></dl>
</li>
</ul>
<a name="putShort(short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putShort</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.74">putShort</a>(short&nbsp;s)</pre>
<div class="block">Puts a <code>short</code> and advances the reader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>s</code> - The short to put</dd></dl>
</li>
</ul>
<a name="putInt(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putInt</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.81">putInt</a>(int&nbsp;i)</pre>
<div class="block">Puts an <code>int</code> and advances the reader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - The int to put</dd></dl>
</li>
</ul>
<a name="putLong(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putLong</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.88">putLong</a>(long&nbsp;l)</pre>
<div class="block">Puts a <code>long</code> and advances the reader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>l</code> - The long to put</dd></dl>
</li>
</ul>
<a name="putFloat(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putFloat</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.95">putFloat</a>(float&nbsp;f)</pre>
<div class="block">Puts a <code>float</code> and advances the reader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>f</code> - The float to put</dd></dl>
</li>
</ul>
<a name="putDouble(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putDouble</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.102">putDouble</a>(double&nbsp;d)</pre>
<div class="block">Puts a <code>double</code> and advances the reader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>d</code> - The double to put</dd></dl>
</li>
</ul>
<a name="putChar(char)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>putChar</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/mina/util/byteaccess/IoRelativeWriter.html#line.109">putChar</a>(char&nbsp;c)</pre>
<div class="block">Puts a <code>char</code> and advances the reader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - The char to put</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/IoRelativeWriter.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/IoRelativeReader.html" title="interface in org.apache.mina.util.byteaccess"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/mina/util/byteaccess/SimpleByteArrayFactory.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/IoRelativeWriter.html" target="_top">Frames</a></li>
<li><a href="IoRelativeWriter.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>Constr&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>Constr&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&#x2013;2016 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p>
</body>
</html>