java/javase/note/docs/api/java.base/java/nio/Buffer.html at master · ScheniCode/java

930 lines (866 loc) · 36.6 KB
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<!-- Generated by javadoc -->
<title>Buffer (Java SE 12 &amp; JDK 12 )</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="keywords" content="java.nio.Buffer class">
<meta name="keywords" content="capacity()">
<meta name="keywords" content="position()">
<meta name="keywords" content="limit()">
<meta name="keywords" content="mark()">
<meta name="keywords" content="reset()">
<meta name="keywords" content="clear()">
<meta name="keywords" content="flip()">
<meta name="keywords" content="rewind()">
<meta name="keywords" content="remaining()">
<meta name="keywords" content="hasRemaining()">
<meta name="keywords" content="isReadOnly()">
<meta name="keywords" content="hasArray()">
<meta name="keywords" content="array()">
<meta name="keywords" content="arrayOffset()">
<meta name="keywords" content="isDirect()">
<meta name="keywords" content="slice()">
<meta name="keywords" content="duplicate()">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
<script type="text/javascript"><!--
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="Buffer (Java SE 12 & JDK 12 )";
    catch(err) {
var data = {"i0":6,"i1":6,"i2":10,"i3":10,"i4":6,"i5":10,"i6":6,"i7":10,"i8":6,"i9":6,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Buffer.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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 &amp; JDK 12</strong> </div></div>
<div class="subNav">
<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 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 class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
<a id="skip.navbar.top">
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span>&nbsp;<a href="../../module-summary.html">java.base</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">java.nio</a></div>
<h2 title="Class Buffer" class="title">Class Buffer</h2>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="../lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<ul class="inheritance">
<li>java.nio.Buffer</li>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="ByteBuffer.html" title="class in java.nio">ByteBuffer</a></code>, <code><a href="CharBuffer.html" title="class in java.nio">CharBuffer</a></code>, <code><a href="DoubleBuffer.html" title="class in java.nio">DoubleBuffer</a></code>, <code><a href="FloatBuffer.html" title="class in java.nio">FloatBuffer</a></code>, <code><a href="IntBuffer.html" title="class in java.nio">IntBuffer</a></code>, <code><a href="LongBuffer.html" title="class in java.nio">LongBuffer</a></code>, <code><a href="ShortBuffer.html" title="class in java.nio">ShortBuffer</a></code></dd>
<pre>public abstract class <span class="typeNameLabel">Buffer</span>
extends <a href="../lang/Object.html" title="class in java.lang">Object</a></pre>
<div class="block">A container for data of a specific primitive type.
 <p> A buffer is a linear, finite sequence of elements of a specific
 primitive type.  Aside from its content, the essential properties of a
 buffer are its capacity, limit, and position: </p>
 <blockquote>
   <p> A buffer's <i>capacity</i> is the number of elements it contains.  The
   capacity of a buffer is never negative and never changes.  </p>
   <p> A buffer's <i>limit</i> is the index of the first element that should
   not be read or written.  A buffer's limit is never negative and is never
   greater than its capacity.  </p>
   <p> A buffer's <i>position</i> is the index of the next element to be
   read or written.  A buffer's position is never negative and is never
   greater than its limit.  </p>
 </blockquote>
 <p> There is one subclass of this class for each non-boolean primitive type.
 <h2> Transferring data </h2>
 <p> Each subclass of this class defines two categories of <i>get</i> and
 <i>put</i> operations: </p>
 <blockquote>
   <p> <i>Relative</i> operations read or write one or more elements starting
   at the current position and then increment the position by the number of
   elements transferred.  If the requested transfer exceeds the limit then a
   relative <i>get</i> operation throws a <a href="BufferUnderflowException.html" title="class in java.nio"><code>BufferUnderflowException</code></a>
   and a relative <i>put</i> operation throws a <a href="BufferOverflowException.html" title="class in java.nio"><code>BufferOverflowException</code></a>; in either case, no data is transferred.  </p>
   <p> <i>Absolute</i> operations take an explicit element index and do not
   affect the position.  Absolute <i>get</i> and <i>put</i> operations throw
   an <a href="../lang/IndexOutOfBoundsException.html" title="class in java.lang"><code>IndexOutOfBoundsException</code></a> if the index argument exceeds the
   limit.  </p>
 </blockquote>
 <p> Data may also, of course, be transferred in to or out of a buffer by the
 I/O operations of an appropriate channel, which are always relative to the
 current position.
 <h2> Marking and resetting </h2>
 <p> A buffer's <i>mark</i> is the index to which its position will be reset
 when the <a href="#reset()"><code>reset</code></a> method is invoked.  The mark is not always
 defined, but when it is defined it is never negative and is never greater
 than the position.  If the mark is defined then it is discarded when the
 position or the limit is adjusted to a value smaller than the mark.  If the
 mark is not defined then invoking the <a href="#reset()"><code>reset</code></a> method causes an
 <a href="InvalidMarkException.html" title="class in java.nio"><code>InvalidMarkException</code></a> to be thrown.
 <h2> Invariants </h2>
 <p> The following invariant holds for the mark, position, limit, and
 capacity values:
 <blockquote>
     <code>0</code> <code>&lt;=</code>
     <i>mark</i> <code>&lt;=</code>
     <i>position</i> <code>&lt;=</code>
     <i>limit</i> <code>&lt;=</code>
     <i>capacity</i>
 </blockquote>
 <p> A newly-created buffer always has a position of zero and a mark that is
 undefined.  The initial limit may be zero, or it may be some other value
 that depends upon the type of the buffer and the manner in which it is
 constructed.  Each element of a newly-allocated buffer is initialized
 <h2> Additional operations </h2>
 <p> In addition to methods for accessing the position, limit, and capacity
 values and for marking and resetting, this class also defines the following
 operations upon buffers:
   <li><p> <a href="#clear()"><code>clear()</code></a> makes a buffer ready for a new sequence of
   channel-read or relative <i>put</i> operations: It sets the limit to the
   capacity and the position to zero.  </p></li>
   <li><p> <a href="#flip()"><code>flip()</code></a> makes a buffer ready for a new sequence of
   channel-write or relative <i>get</i> operations: It sets the limit to the
   current position and then sets the position to zero.  </p></li>
   <li><p> <a href="#rewind()"><code>rewind()</code></a> makes a buffer ready for re-reading the data that
   it already contains: It leaves the limit unchanged and sets the position
   to zero.  </p></li>
   <li><p> <a href="#slice()"><code>slice()</code></a> creates a subsequence of a buffer: It leaves the
   limit and the position unchanged. </p></li>
   <li><p> <a href="#duplicate()"><code>duplicate()</code></a> creates a shallow copy of a buffer: It leaves
   the limit and the position unchanged. </p></li>
 <h2> Read-only buffers </h2>
 <p> Every buffer is readable, but not every buffer is writable.  The
 mutation methods of each buffer class are specified as <i>optional
 operations</i> that will throw a <a href="ReadOnlyBufferException.html" title="class in java.nio"><code>ReadOnlyBufferException</code></a> when
 invoked upon a read-only buffer.  A read-only buffer does not allow its
 content to be changed, but its mark, position, and limit values are mutable.
 Whether or not a buffer is read-only may be determined by invoking its
 <a href="#isReadOnly()"><code>isReadOnly</code></a> method.
 <h2> Thread safety </h2>
 <p> Buffers are not safe for use by multiple concurrent threads.  If a
 buffer is to be used by more than one thread then access to the buffer
 should be controlled by appropriate synchronization.
 <h2> Invocation chaining </h2>
 <p> Methods in this class that do not otherwise have a value to return are
 specified to return the buffer upon which they are invoked.  This allows
 method invocations to be chained; for example, the sequence of statements
 <blockquote><pre>
 b.position(23);
 b.limit(42);</pre></blockquote>
 can be replaced by the single, more compact statement
 <blockquote><pre>
 b.flip().position(23).limit(42);</pre></blockquote></div>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<h3>Method Summary</h3>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
<tr class="altColor" id="i0">
<td class="colFirst"><code>abstract <a href="../lang/Object.html" title="class in java.lang">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#array()">array</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the array that backs this
 buffer&nbsp;&nbsp;<i>(optional operation)</i>.</div>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>abstract int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#arrayOffset()">arrayOffset</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the offset within this buffer's backing array of the first
 element of the buffer&nbsp;&nbsp;<i>(optional operation)</i>.</div>
<tr class="altColor" id="i2">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#capacity()">capacity</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns this buffer's capacity.</div>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="Buffer.html" title="class in java.nio">Buffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
<td class="colLast">
<div class="block">Clears this buffer.</div>
<tr class="altColor" id="i4">
<td class="colFirst"><code>abstract <a href="Buffer.html" title="class in java.nio">Buffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#duplicate()">duplicate</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new buffer that shares this buffer's content.</div>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="Buffer.html" title="class in java.nio">Buffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flip()">flip</a></span>()</code></th>
<td class="colLast">
<div class="block">Flips this buffer.</div>
<tr class="altColor" id="i6">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasArray()">hasArray</a></span>()</code></th>
<td class="colLast">
<div class="block">Tells whether or not this buffer is backed by an accessible
 array.</div>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasRemaining()">hasRemaining</a></span>()</code></th>
<td class="colLast">
<div class="block">Tells whether there are any elements between the current position and
 the limit.</div>
<tr class="altColor" id="i8">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDirect()">isDirect</a></span>()</code></th>
<td class="colLast">
<div class="block">Tells whether or not this buffer is
 <a href="ByteBuffer.html#direct"><i>direct</i></a>.</div>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isReadOnly()">isReadOnly</a></span>()</code></th>
<td class="colLast">
<div class="block">Tells whether or not this buffer is read-only.</div>
<tr class="altColor" id="i10">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#limit()">limit</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns this buffer's limit.</div>
<tr class="rowColor" id="i11">
<td class="colFirst"><code><a href="Buffer.html" title="class in java.nio">Buffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#limit(int)">limit</a></span>&#8203;(int&nbsp;newLimit)</code></th>
<td class="colLast">
<div class="block">Sets this buffer's limit.</div>
<tr class="altColor" id="i12">
<td class="colFirst"><code><a href="Buffer.html" title="class in java.nio">Buffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mark()">mark</a></span>()</code></th>
<td class="colLast">
<div class="block">Sets this buffer's mark at its position.</div>
<tr class="rowColor" id="i13">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#position()">position</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns this buffer's position.</div>
<tr class="altColor" id="i14">
<td class="colFirst"><code><a href="Buffer.html" title="class in java.nio">Buffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#position(int)">position</a></span>&#8203;(int&nbsp;newPosition)</code></th>
<td class="colLast">
<div class="block">Sets this buffer's position.</div>
<tr class="rowColor" id="i15">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remaining()">remaining</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of elements between the current position and the
 limit.</div>
<tr class="altColor" id="i16">
<td class="colFirst"><code><a href="Buffer.html" title="class in java.nio">Buffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets this buffer's position to the previously-marked position.</div>
<tr class="rowColor" id="i17">
<td class="colFirst"><code><a href="Buffer.html" title="class in java.nio">Buffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rewind()">rewind</a></span>()</code></th>
<td class="colLast">
<div class="block">Rewinds this buffer.</div>
<tr class="altColor" id="i18">
<td class="colFirst"><code>abstract <a href="Buffer.html" title="class in java.nio">Buffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#slice()">slice</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new buffer whose content is a shared subsequence of
 this buffer's content.</div>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<h3>Methods declared in class&nbsp;java.lang.<a href="../lang/Object.html" title="class in java.lang">Object</a></h3>
<code><a href="../lang/Object.html#clone()">clone</a>, <a href="../lang/Object.html#equals(java.lang.Object)">equals</a>, <a href="../lang/Object.html#finalize()">finalize</a>, <a href="../lang/Object.html#getClass()">getClass</a>, <a href="../lang/Object.html#hashCode()">hashCode</a>, <a href="../lang/Object.html#notify()">notify</a>, <a href="../lang/Object.html#notifyAll()">notifyAll</a>, <a href="../lang/Object.html#toString()">toString</a>, <a href="../lang/Object.html#wait()">wait</a>, <a href="../lang/Object.html#wait(long)">wait</a>, <a href="../lang/Object.html#wait(long,int)">wait</a></code></li>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<h3>Method Detail</h3>
<a id="capacity()">
<ul class="blockList">
<li class="blockList">
<h4>capacity</h4>
<pre class="methodSignature">public final&nbsp;int&nbsp;capacity()</pre>
<div class="block">Returns this buffer's capacity.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The capacity of this buffer</dd>
<a id="position()">
<ul class="blockList">
<li class="blockList">
<h4>position</h4>
<pre class="methodSignature">public final&nbsp;int&nbsp;position()</pre>
<div class="block">Returns this buffer's position.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The position of this buffer</dd>
<a id="position(int)">
<ul class="blockList">
<li class="blockList">
<h4>position</h4>
<pre class="methodSignature">public&nbsp;<a href="Buffer.html" title="class in java.nio">Buffer</a>&nbsp;position&#8203;(int&nbsp;newPosition)</pre>
<div class="block">Sets this buffer's position.  If the mark is defined and larger than the
 new position then it is discarded.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newPosition</code> - The new position value; must be non-negative
         and no larger than the current limit</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This buffer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - If the preconditions on <code>newPosition</code> do not hold</dd>
<a id="limit()">
<ul class="blockList">
<li class="blockList">
<h4>limit</h4>
<pre class="methodSignature">public final&nbsp;int&nbsp;limit()</pre>
<div class="block">Returns this buffer's limit.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The limit of this buffer</dd>
<a id="limit(int)">
<ul class="blockList">
<li class="blockList">
<h4>limit</h4>
<pre class="methodSignature">public&nbsp;<a href="Buffer.html" title="class in java.nio">Buffer</a>&nbsp;limit&#8203;(int&nbsp;newLimit)</pre>
<div class="block">Sets this buffer's limit.  If the position is larger than the new limit
 then it is set to the new limit.  If the mark is defined and larger than
 the new limit then it is discarded.</div>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newLimit</code> - The new limit value; must be non-negative
         and no larger than this buffer's capacity</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This buffer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../lang/IllegalArgumentException.html" title="class in java.lang">IllegalArgumentException</a></code> - If the preconditions on <code>newLimit</code> do not hold</dd>
<a id="mark()">
<ul class="blockList">
<li class="blockList">
<h4>mark</h4>
<pre class="methodSignature">public&nbsp;<a href="Buffer.html" title="class in java.nio">Buffer</a>&nbsp;mark()</pre>
<div class="block">Sets this buffer's mark at its position.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This buffer</dd>
<a id="reset()">
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre class="methodSignature">public&nbsp;<a href="Buffer.html" title="class in java.nio">Buffer</a>&nbsp;reset()</pre>
<div class="block">Resets this buffer's position to the previously-marked position.
 <p> Invoking this method neither changes nor discards the mark's
 value. </p></div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This buffer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="InvalidMarkException.html" title="class in java.nio">InvalidMarkException</a></code> - If the mark has not been set</dd>
<a id="clear()">
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre class="methodSignature">public&nbsp;<a href="Buffer.html" title="class in java.nio">Buffer</a>&nbsp;clear()</pre>
<div class="block">Clears this buffer.  The position is set to zero, the limit is set to
 the capacity, and the mark is discarded.
 <p> Invoke this method before using a sequence of channel-read or
 <i>put</i> operations to fill this buffer.  For example:
 <blockquote><pre>
 buf.clear();     // Prepare buffer for reading
 in.read(buf);    // Read data</pre></blockquote>
 <p> This method does not actually erase the data in the buffer, but it
 is named as if it did because it will most often be used in situations
 in which that might as well be the case. </p></div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This buffer</dd>
<a id="flip()">
<ul class="blockList">
<li class="blockList">
<h4>flip</h4>
<pre class="methodSignature">public&nbsp;<a href="Buffer.html" title="class in java.nio">Buffer</a>&nbsp;flip()</pre>
<div class="block">Flips this buffer.  The limit is set to the current position and then
 the position is set to zero.  If the mark is defined then it is
 discarded.
 <p> After a sequence of channel-read or <i>put</i> operations, invoke
 this method to prepare for a sequence of channel-write or relative
 <i>get</i> operations.  For example:
 <blockquote><pre>
 buf.put(magic);    // Prepend header
 in.read(buf);      // Read data into rest of buffer
 buf.flip();        // Flip buffer
 out.write(buf);    // Write header + data to channel</pre></blockquote>
 <p> This method is often used in conjunction with the <a href="ByteBuffer.html#compact()"><code>compact</code></a> method when transferring data from
 one place to another.  </p></div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This buffer</dd>
<a id="rewind()">
<ul class="blockList">
<li class="blockList">
<h4>rewind</h4>
<pre class="methodSignature">public&nbsp;<a href="Buffer.html" title="class in java.nio">Buffer</a>&nbsp;rewind()</pre>
<div class="block">Rewinds this buffer.  The position is set to zero and the mark is
 discarded.
 <p> Invoke this method before a sequence of channel-write or <i>get</i>
 operations, assuming that the limit has already been set
 appropriately.  For example:
 <blockquote><pre>
 out.write(buf);    // Write remaining data
 buf.rewind();      // Rewind buffer
 buf.get(array);    // Copy data into array</pre></blockquote></div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This buffer</dd>
<a id="remaining()">
<ul class="blockList">
<li class="blockList">
<h4>remaining</h4>
<pre class="methodSignature">public final&nbsp;int&nbsp;remaining()</pre>
<div class="block">Returns the number of elements between the current position and the
 limit.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of elements remaining in this buffer</dd>
<a id="hasRemaining()">
<ul class="blockList">
<li class="blockList">
<h4>hasRemaining</h4>
<pre class="methodSignature">public final&nbsp;boolean&nbsp;hasRemaining()</pre>
<div class="block">Tells whether there are any elements between the current position and
 the limit.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if, and only if, there is at least one element
          remaining in this buffer</dd>
<a id="isReadOnly()">
<ul class="blockList">
<li class="blockList">
<h4>isReadOnly</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;isReadOnly()</pre>
<div class="block">Tells whether or not this buffer is read-only.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if, and only if, this buffer is read-only</dd>
<a id="hasArray()">
<ul class="blockList">
<li class="blockList">
<h4>hasArray</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;hasArray()</pre>
<div class="block">Tells whether or not this buffer is backed by an accessible
 <p> If this method returns <code>true</code> then the <a href="#array()"><code>array</code></a>
 and <a href="#arrayOffset()"><code>arrayOffset</code></a> methods may safely be invoked.
 </p></div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if, and only if, this buffer
          is backed by an array and is not read-only</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
<a id="array()">
<ul class="blockList">
<li class="blockList">
<h4>array</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="../lang/Object.html" title="class in java.lang">Object</a>&nbsp;array()</pre>
<div class="block">Returns the array that backs this
 buffer&nbsp;&nbsp;<i>(optional operation)</i>.
 <p> This method is intended to allow array-backed buffers to be
 passed to native code more efficiently. Concrete subclasses
 provide more strongly-typed return values for this method.
 <p> Modifications to this buffer's content will cause the returned
 array's content to be modified, and vice versa.
 <p> Invoke the <a href="#hasArray()"><code>hasArray</code></a> method before invoking this
 method in order to ensure that this buffer has an accessible backing
 array.  </p></div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The array that backs this buffer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="ReadOnlyBufferException.html" title="class in java.nio">ReadOnlyBufferException</a></code> - If this buffer is backed by an array but is read-only</dd>
<dd><code><a href="../lang/UnsupportedOperationException.html" title="class in java.lang">UnsupportedOperationException</a></code> - If this buffer is not backed by an accessible array</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
<a id="arrayOffset()">
<ul class="blockList">
<li class="blockList">
<h4>arrayOffset</h4>
<pre class="methodSignature">public abstract&nbsp;int&nbsp;arrayOffset()</pre>
<div class="block">Returns the offset within this buffer's backing array of the first
 element of the buffer&nbsp;&nbsp;<i>(optional operation)</i>.
 <p> If this buffer is backed by an array then buffer position <i>p</i>
 corresponds to array index <i>p</i>&nbsp;+&nbsp;<code>arrayOffset()</code>.
 <p> Invoke the <a href="#hasArray()"><code>hasArray</code></a> method before invoking this
 method in order to ensure that this buffer has an accessible backing
 array.  </p></div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The offset within this buffer's array
          of the first element of the buffer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="ReadOnlyBufferException.html" title="class in java.nio">ReadOnlyBufferException</a></code> - If this buffer is backed by an array but is read-only</dd>
<dd><code><a href="../lang/UnsupportedOperationException.html" title="class in java.lang">UnsupportedOperationException</a></code> - If this buffer is not backed by an accessible array</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
<a id="isDirect()">
<ul class="blockList">
<li class="blockList">
<h4>isDirect</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;isDirect()</pre>
<div class="block">Tells whether or not this buffer is
 <a href="ByteBuffer.html#direct"><i>direct</i></a>.</div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if, and only if, this buffer is direct</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
<a id="slice()">
<ul class="blockList">
<li class="blockList">
<h4>slice</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="Buffer.html" title="class in java.nio">Buffer</a>&nbsp;slice()</pre>
<div class="block">Creates a new buffer whose content is a shared subsequence of
 this buffer's content.
 <p> The content of the new buffer will start at this buffer's current
 position.  Changes to this buffer's content will be visible in the new
 buffer, and vice versa; the two buffers' position, limit, and mark
 values will be independent.
 <p> The new buffer's position will be zero, its capacity and its limit
 will be the number of elements remaining in this buffer, its mark will be
 undefined. The new buffer will be direct if, and only if, this buffer is
 direct, and it will be read-only if, and only if, this buffer is
 read-only.  </p></div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The new buffer</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<a id="duplicate()">
<ul class="blockListLast">
<li class="blockList">
<h4>duplicate</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="Buffer.html" title="class in java.nio">Buffer</a>&nbsp;duplicate()</pre>
<div class="block">Creates a new buffer that shares this buffer's content.
 <p> The content of the new buffer will be that of this buffer.  Changes
 to this buffer's content will be visible in the new buffer, and vice
 versa; the two buffers' position, limit, and mark values will be
 independent.
 <p> The new buffer's capacity, limit, position and mark values will be
 identical to those of this buffer. The new buffer will be direct if, and
 only if, this buffer is direct, and it will be read-only if, and only if,
 this buffer is read-only.  </p></div>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The new buffer</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Buffer.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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
<div class="aboutLanguage"><div style="margin-top: 14px;"><strong>Java SE 12 &amp; JDK 12</strong> </div></div>
<div class="subNav">
<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 class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
<a id="skip.navbar.bottom">
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><a href="https://bugreport.java.com/bugreport/">Report a bug or suggest an enhancement</a><br> For further API reference and developer documentation see the <a href="https://docs.oracle.com/pls/topic/lookup?ctx=javase12.0.2&amp;id=homepage" target="_blank">Java SE Documentation</a>, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.<br> <a href="../../../../legal/copyright.html">Copyright</a> &copy; 1993, 2019, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.<br>All rights reserved. Use is subject to <a href="https://www.oracle.com/technetwork/java/javase/terms/license/java12.0.2speclicense.html">license terms</a> and the <a href="https://www.oracle.com/technetwork/java/redist-137594.html">documentation redistribution policy</a>. <!-- Version 12.0.2+10 --></small></p>
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

Buffer.html

Latest commit

History

Buffer.html

File metadata and controls
