procyberian/gcc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Buffer.java, [...]: Fixed javadocs all over.

Browse source 
2004-07-09  Dalibor Topic  <robilad@kaffe.org>

	* java/nio/Buffer.java,
	java/nio/ByteBuffer.java,
	java/nio/ByteBufferHelper.java,
	java/nio/ByteBufferImpl.java,
	java/nio/CharBuffer.java,
	java/nio/CharBufferImpl.java,
	java/nio/CharViewBufferImpl.java,
	java/nio/DirectByteBufferImpl.java,
	java/nio/DoubleBuffer.java,
	java/nio/DoubleBufferImpl.java,
	java/nio/DoubleViewBufferImpl.java,
	java/nio/FloatBuffer.java,
	java/nio/FloatBufferImpl.java,
	java/nio/FloatViewBufferImpl.java,
	java/nio/IntBuffer.java,
	java/nio/IntBufferImpl.java,
	java/nio/IntViewBufferImpl.java,
	java/nio/LongBuffer.java,
	java/nio/LongBufferImpl.java,
	java/nio/LongViewBufferImpl.java,
	java/nio/MappedByteBufferImpl.java,
	java/nio/ShortBuffer.java,
	java/nio/ShortBufferImpl.java,
	java/nio/ShortViewBufferImpl.java:
        Fixed javadocs all over. Improved input error
        checking.

	* java/nio/Buffer.java
	(checkForUnderflow, checkForOverflow, checkIndex,
	checkIfReadOnly, checkArraySize): New helper methods
        for error checking.

	* java/nio/ByteBufferHelper.java
	(checkRemainingForRead, checkRemainingForWrite,
	checkAvailableForRead, checkAvailableForWrite): Removed
        no longer needed methods.

From-SVN: r84366
This commit is contained in:
Dalibor Topic 2004-07-09 13:40:29 +00:00 • committed by Michael Koch
parent e484d7d5b3
commit 23c41c0833
25 changed files with 558 additions and 278 deletions
Download patch file Download diff file Expand all files Collapse all files

42
libjava/java/nio/DoubleBuffer.java
View file

@ -83,8 +83,9 @@ public abstract class DoubleBuffer extends Buffer
}
/**
* This method transfers <code>doubles<code> from this buffer into the given
* destination array.
* This method transfers <code>double</code>s from this buffer into the given
* destination array. Before the transfer, it checks if there are fewer than
* length <code>double</code>s remaining in this buffer.
*
* @param dst The destination array
* @param offset The offset within the array of the first <code>double</code>
@ -93,12 +94,15 @@ public abstract class DoubleBuffer extends Buffer
* must be non-negative and no larger than dst.length - offset.
*
* @exception BufferUnderflowException If there are fewer than length
* <code>doubles</code> remaining in this buffer.
* <code>double</code>s remaining in this buffer.
* @exception IndexOutOfBoundsException If the preconditions on the offset
* and length parameters do not hold.
*/
public DoubleBuffer get (double[] dst, int offset, int length)
{
checkArraySize(dst.length, offset, length);
checkForUnderflow(length);
for (int i = offset; i < offset + length; i++)
{
dst [i] = get ();
@ -108,13 +112,13 @@ public abstract class DoubleBuffer extends Buffer
}
/**
* This method transfers <code>doubles<code> from this buffer into the given
* This method transfers <code>double</code>s from this buffer into the given
* destination array.
*
* @param dst The byte array to write into.
*
* @exception BufferUnderflowException If there are fewer than dst.length
* <code>doubles</code> remaining in this buffer.
* <code>double</code>s remaining in this buffer.
*/
public DoubleBuffer get (double[] dst)
{
@ -123,12 +127,13 @@ public abstract class DoubleBuffer extends Buffer
/**
* Writes the content of the the <code>DoubleBUFFER</code> src
* into the buffer.
* into the buffer. Before the transfer, it checks if there is fewer than
* <code>src.remaining()</code> space remaining in this buffer.
*
* @param src The source data.
*
* @exception BufferOverflowException If there is insufficient space in this
* buffer for the remaining <code>doubles<code> in the source buffer.
* buffer for the remaining <code>double</code>s in the source buffer.
* @exception IllegalArgumentException If the source buffer is this buffer.
* @exception ReadOnlyBufferException If this buffer is read-only.
*/
@ -137,8 +142,7 @@ public abstract class DoubleBuffer extends Buffer
if (src == this)
throw new IllegalArgumentException ();
if (src.remaining () > remaining ())
throw new BufferOverflowException ();
checkForOverflow(src.remaining ());
if (src.remaining () > 0)
{
@ -152,7 +156,8 @@ public abstract class DoubleBuffer extends Buffer
/**
* Writes the content of the the <code>double array</code> src
* into the buffer.
* into the buffer. Before the transfer, it checks if there is fewer than
* length space remaining in this buffer.
*
* @param src The array to copy into the buffer.
* @param offset The offset within the array of the first byte to be read;
@ -161,13 +166,16 @@ public abstract class DoubleBuffer extends Buffer
* must be non-negative and no larger than src.length - offset.
*
* @exception BufferOverflowException If there is insufficient space in this
* buffer for the remaining <code>doubles<code> in the source array.
* buffer for the remaining <code>double</code>s in the source array.
* @exception IndexOutOfBoundsException If the preconditions on the offset
* and length parameters do not hold
* @exception ReadOnlyBufferException If this buffer is read-only.
*/
public DoubleBuffer put (double[] src, int offset, int length)
{
checkArraySize(src.length, offset, length);
checkForOverflow(length);
for (int i = offset; i < offset + length; i++)
put (src [i]);
@ -181,7 +189,7 @@ public abstract class DoubleBuffer extends Buffer
* @param src The array to copy into the buffer.
*
* @exception BufferOverflowException If there is insufficient space in this
* buffer for the remaining <code>doubles<code> in the source array.
* buffer for the remaining <code>double</code>s in the source array.
* @exception ReadOnlyBufferException If this buffer is read-only.
*/
public final DoubleBuffer put (double[] src)
@ -211,8 +219,7 @@ public abstract class DoubleBuffer extends Buffer
if (backing_buffer == null)
throw new UnsupportedOperationException ();
if (isReadOnly ())
throw new ReadOnlyBufferException ();
checkIfReadOnly();
return backing_buffer;
}
@ -229,8 +236,7 @@ public abstract class DoubleBuffer extends Buffer
if (backing_buffer == null)
throw new UnsupportedOperationException ();
if (isReadOnly ())
throw new ReadOnlyBufferException ();
checkIfReadOnly();
return array_offset;
}
@ -298,7 +304,7 @@ public abstract class DoubleBuffer extends Buffer
* and then increments the position.
*
* @exception BufferUnderflowException If there are no remaining
* <code>doubles</code> in this buffer.
* <code>double</code>s in this buffer.
*/
public abstract double get ();
@ -307,7 +313,7 @@ public abstract class DoubleBuffer extends Buffer
* and then increments the position.
*
* @exception BufferOverflowException If there no remaining
* <code>doubles</code> in this buffer.
* <code>double</code>s in this buffer.
* @exception ReadOnlyBufferException If this buffer is read-only.
*/
public abstract DoubleBuffer put (double b);