Double buffers can be created either by allocation, which allocates space for the buffer's
content, by wrapping an existing
double array into a buffer, or by creating a
view of an existing byte buffer.

Like a byte buffer, a double buffer is either direct or non-direct. A
double buffer created via the wrap methods of this class will
be non-direct. A double buffer created as a view of a byte buffer will
be direct if, and only if, the byte buffer itself is direct. Whether or not
a double buffer is direct may be determined by invoking the isDirect method.

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.

Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object, or
some other thread interrupts the current thread, or a certain
amount of real time has elapsed.

Public methods

allocate

The new buffer's position will be zero, its limit will be its
capacity, its mark will be undefined, and each of its elements will be
initialized to zero. It will have a backing array,
and its array offset will be zero.

asReadOnlyBuffer

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; the new
buffer itself, however, will be read-only and will not allow the shared
content to be modified. The two buffers' position, limit, and mark
values will be independent.

The new buffer's capacity, limit, position, and mark values will be
identical to those of this buffer.

If this buffer is itself read-only then this method behaves in
exactly the same way as the duplicate method.

compact

The doubles between the buffer's current position and its limit,
if any, are copied to the beginning of the buffer. That is, the
double at index p = position() is copied
to index zero, the double at index p + 1 is copied
to index one, and so forth until the double at index
limit() - 1 is copied to index
n = limit() - 1 - p.
The buffer's position is then set to n+1 and its limit is set to
its capacity. The mark, if defined, is discarded.

The buffer's position is set to the number of doubles copied,
rather than to zero, so that an invocation of this method can be
followed immediately by an invocation of another relative put
method.

compareTo

Two double buffers are compared by comparing their sequences of
remaining elements lexicographically, without regard to the starting
position of each sequence within its corresponding buffer.
Pairs of double elements are compared as if by invoking
Double.compare(double, double), except that
-0.0 and 0.0 are considered to be equal.
Double.NaN is considered by this method to be equal
to itself and greater than all other double values
(including Double.POSITIVE_INFINITY).

A double buffer is not comparable to any other type of object.

Parameters

that

DoubleBuffer

Returns

int

A negative integer, zero, or a positive integer as this buffer
is less than, equal to, or greater than the given buffer

duplicate

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.

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.

The two sequences of remaining elements, considered
independently of their starting positions, are pointwise equal.
This method considers two double elements a and b
to be equal if
(a == b) || (Double.isNaN(a) && Double.isNaN(b)).
The values -0.0 and +0.0 are considered to be
equal, unlike Double.equals(Object).

get

This method transfers doubles from this buffer into the given
destination array. If there are fewer doubles remaining in the
buffer than are required to satisfy the request, that is, if
length>remaining(), then no
doubles are transferred and a BufferUnderflowException is
thrown.

Otherwise, this method copies length doubles from this
buffer into the given array, starting at the current position of this
buffer and at the given offset in the array. The position of this
buffer is then incremented by length.

In other words, an invocation of this method of the form
src.get(dst, off, len) has exactly the same effect as
the loop

for (int i = off; i < off + len; i++)
dst[i] = src.get();

except that it first checks that there are sufficient doubles in
this buffer and it is potentially much more efficient.

Parameters

dst

double: The array into which doubles are to be written

offset

int: The offset within the array of the first double to be
written; must be non-negative and no larger than
dst.length

length

int: The maximum number of doubles to be written to the given
array; must be non-negative and no larger than
dst.length - offset

order

The byte order of a double buffer created by allocation or by
wrapping an existing double array is the native order of the underlying
hardware. The byte order of a double buffer created as a view of a byte buffer is that of the
byte buffer at the moment that the view is created.

put

This method transfers the doubles remaining in the given source
buffer into this buffer. If there are more doubles remaining in the
source buffer than in this buffer, that is, if
src.remaining()>remaining(),
then no doubles are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies
n = src.remaining() doubles from the given
buffer into this buffer, starting at each buffer's current position.
The positions of both buffers are then incremented by n.

In other words, an invocation of this method of the form
dst.put(src) has exactly the same effect as the loop

while (src.hasRemaining())
dst.put(src.get());

except that it first checks that there is sufficient space in this
buffer and it is potentially much more efficient.

Parameters

src

DoubleBuffer: The source buffer from which doubles are to be read;
must not be this buffer

put

This method transfers doubles into this buffer from the given
source array. If there are more doubles to be copied from the array
than remain in this buffer, that is, if
length>remaining(), then no
doubles are transferred and a BufferOverflowException is
thrown.

Otherwise, this method copies length doubles from the
given array into this buffer, starting at the given offset in the array
and at the current position of this buffer. The position of this buffer
is then incremented by length.

In other words, an invocation of this method of the form
dst.put(src, off, len) has exactly the same effect as
the loop

for (int i = off; i < off + len; i++)
dst.put(a[i]);

except that it first checks that there is sufficient space in this
buffer and it is potentially much more efficient.

Parameters

src

double: The array from which doubles are to be read

offset

int: The offset within the array of the first double to be read;
must be non-negative and no larger than array.length

length

int: The number of doubles to be read from the given array;
must be non-negative and no larger than
array.length - offset

slice

Creates a new double buffer whose content is a shared subsequence of
this buffer's content.

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.

The new buffer's position will be zero, its capacity and its limit
will be the number of doubles remaining in this buffer, and 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.

wrap

The new buffer will be backed by the given double array;
that is, modifications to the buffer will cause the array to be modified
and vice versa. The new buffer's capacity and limit will be
array.length, its position will be zero, and its mark will be
undefined. Its backing array will be the
given array, and its array offset> will
be zero.

wrap

The new buffer will be backed by the given double array;
that is, modifications to the buffer will cause the array to be modified
and vice versa. The new buffer's capacity will be
array.length, its position will be offset, its limit
will be offset + length, and its mark will be undefined. Its
backing array will be the given array, and
its array offset will be zero.

Parameters

array

double: The array that will back the new buffer

offset

int: The offset of the subarray to be used; must be non-negative and
no larger than array.length. The new buffer's position
will be set to this value.

length

int: The length of the subarray to be used;
must be non-negative and no larger than
array.length - offset.
The new buffer's limit will be set to offset + length.