< prev index next >

src/java.base/share/classes/java/nio/X-Buffer.java.template

Print this page
8202397: Typo in X-Buffer javadoc
Reviewed-by: psandoz


 683      * Relative bulk <i>get</i> method.
 684      *
 685      * <p> This method transfers $type$s from this buffer into the given
 686      * destination array.  If there are fewer $type$s remaining in the
 687      * buffer than are required to satisfy the request, that is, if
 688      * {@code length}&nbsp;{@code >}&nbsp;{@code remaining()}, then no
 689      * $type$s are transferred and a {@link BufferUnderflowException} is
 690      * thrown.
 691      *
 692      * <p> Otherwise, this method copies {@code length} $type$s from this
 693      * buffer into the given array, starting at the current position of this
 694      * buffer and at the given offset in the array.  The position of this
 695      * buffer is then incremented by {@code length}.
 696      *
 697      * <p> In other words, an invocation of this method of the form
 698      * <code>src.get(dst,&nbsp;off,&nbsp;len)</code> has exactly the same effect as
 699      * the loop
 700      *
 701      * <pre>{@code
 702      *     for (int i = off; i < off + len; i++)
 703      *         dst[i] = src.get():
 704      * }</pre>
 705      *
 706      * except that it first checks that there are sufficient $type$s in
 707      * this buffer and it is potentially much more efficient.
 708      *
 709      * @param  dst
 710      *         The array into which $type$s are to be written
 711      *
 712      * @param  offset
 713      *         The offset within the array of the first $type$ to be
 714      *         written; must be non-negative and no larger than
 715      *         {@code dst.length}
 716      *
 717      * @param  length
 718      *         The maximum number of $type$s to be written to the given
 719      *         array; must be non-negative and no larger than
 720      *         {@code dst.length - offset}
 721      *
 722      * @return  This buffer
 723      *




 683      * Relative bulk <i>get</i> method.
 684      *
 685      * <p> This method transfers $type$s from this buffer into the given
 686      * destination array.  If there are fewer $type$s remaining in the
 687      * buffer than are required to satisfy the request, that is, if
 688      * {@code length}&nbsp;{@code >}&nbsp;{@code remaining()}, then no
 689      * $type$s are transferred and a {@link BufferUnderflowException} is
 690      * thrown.
 691      *
 692      * <p> Otherwise, this method copies {@code length} $type$s from this
 693      * buffer into the given array, starting at the current position of this
 694      * buffer and at the given offset in the array.  The position of this
 695      * buffer is then incremented by {@code length}.
 696      *
 697      * <p> In other words, an invocation of this method of the form
 698      * <code>src.get(dst,&nbsp;off,&nbsp;len)</code> has exactly the same effect as
 699      * the loop
 700      *
 701      * <pre>{@code
 702      *     for (int i = off; i < off + len; i++)
 703      *         dst[i] = src.get();
 704      * }</pre>
 705      *
 706      * except that it first checks that there are sufficient $type$s in
 707      * this buffer and it is potentially much more efficient.
 708      *
 709      * @param  dst
 710      *         The array into which $type$s are to be written
 711      *
 712      * @param  offset
 713      *         The offset within the array of the first $type$ to be
 714      *         written; must be non-negative and no larger than
 715      *         {@code dst.length}
 716      *
 717      * @param  length
 718      *         The maximum number of $type$s to be written to the given
 719      *         array; must be non-negative and no larger than
 720      *         {@code dst.length - offset}
 721      *
 722      * @return  This buffer
 723      *


< prev index next >