public abstract class DoubleBuffer extends Buffer implements Comparable<DoubleBuffer>
A double buffer can be created in either one of the following ways:
Allocate a new double array and create a buffer
based on it;Wrap an existing double array to create a new
buffer;ByteBuffer.asDoubleBuffer to
create a double buffer based on a byte buffer.| Modifier and Type | Method and Description |
|---|---|
static DoubleBuffer |
allocate(int capacity)
Creates a double buffer based on a newly allocated double array.
|
double[] |
array()
Returns the double array which this buffer is based on, if there is one.
|
int |
arrayOffset()
Returns the offset of the double array which this buffer is based on, if
there is one.
|
abstract DoubleBuffer |
asReadOnlyBuffer()
Returns a read-only buffer that shares its content with this buffer.
|
abstract DoubleBuffer |
compact()
Compacts this double buffer.
|
int |
compareTo(DoubleBuffer otherBuffer)
Compare the remaining doubles of this buffer to another double buffer's
remaining doubles.
|
abstract DoubleBuffer |
duplicate()
Returns a duplicated buffer that shares its content with this buffer.
|
boolean |
equals(Object other)
Checks whether this double buffer is equal to another object.
|
abstract double |
get()
Returns the double at the current position and increases the position by
1.
|
DoubleBuffer |
get(double[] dest)
Reads doubles from the current position into the specified double array
and increases the position by the number of doubles read.
|
DoubleBuffer |
get(double[] dest,
int off,
int len)
Reads doubles from the current position into the specified double array,
starting from the specified offset, and increases the position by the
number of doubles read.
|
abstract double |
get(int index)
Returns a double at the specified index; the position is not changed.
|
boolean |
hasArray()
Indicates whether this buffer is based on a double array and is
read/write.
|
int |
hashCode()
Calculates this buffer's hash code from the remaining chars.
|
abstract boolean |
isDirect()
Indicates whether this buffer is direct.
|
abstract ByteOrder |
order()
Returns the byte order used by this buffer when converting doubles
from/to bytes.
|
abstract DoubleBuffer |
put(double d)
Writes the given double to the current position and increases the
position by 1.
|
DoubleBuffer |
put(double[] src)
Writes doubles from the given double array to the current position and
increases the position by the number of doubles written.
|
DoubleBuffer |
put(double[] src,
int off,
int len)
Writes doubles from the given double array, starting from the specified
offset, to the current position and increases the position by the number
of doubles written.
|
DoubleBuffer |
put(DoubleBuffer src)
Writes all the remaining doubles of the
src double buffer to this
buffer's current position, and increases both buffers' position by the
number of doubles copied. |
abstract DoubleBuffer |
put(int index,
double d)
Write a double to the specified index of this buffer and the position is
not changed.
|
abstract DoubleBuffer |
slice()
Returns a sliced buffer that shares its content with this buffer.
|
String |
toString()
Returns a string representing the state of this double buffer.
|
static DoubleBuffer |
wrap(double[] array)
Creates a new double buffer by wrapping the given double array.
|
static DoubleBuffer |
wrap(double[] array,
int start,
int len)
Creates a new double buffer by wrapping the given double array.
|
public static DoubleBuffer allocate(int capacity)
capacity - the capacity of the new buffer.IllegalArgumentException - if capacity is less than zero.public static DoubleBuffer wrap(double[] array)
Calling this method has the same effect as
wrap(array, 0, array.length).
array - the double array which the new buffer will be based on.public static DoubleBuffer wrap(double[] array, int start, int len)
The new buffer's position will be start, limit will be
start + len, capacity will be the length of the array.
array - the double array which the new buffer will be based on.start - the start index, must not be negative and not greater than
array.length.len - the length, must not be negative and not greater than
array.length - start.IndexOutOfBoundsException - if either start or len is invalid.public final double[] array()
ReadOnlyBufferException - if this buffer is based on an array but it is read-only.UnsupportedOperationException - if this buffer is not based on an array.public final int arrayOffset()
The offset is the index of the array corresponding to the zero position of the buffer.
ReadOnlyBufferException - if this buffer is based on an array, but it is read-only.UnsupportedOperationException - if this buffer is not based on an array.public abstract DoubleBuffer asReadOnlyBuffer()
The returned buffer is guaranteed to be a new instance, even if this buffer is read-only itself. The new buffer's position, limit, capacity and mark are the same as this buffer's.
The new buffer shares its content with this buffer, which means that this buffer's change of content will be visible to the new buffer. The two buffer's position, limit and mark are independent.
public abstract DoubleBuffer compact()
The remaining doubles will be moved to the head of the buffer, staring
from position zero. Then the position is set to remaining(); the
limit is set to capacity; the mark is cleared.
ReadOnlyBufferException - if no changes may be made to the contents of this buffer.public int compareTo(DoubleBuffer otherBuffer)
compareTo in interface Comparable<DoubleBuffer>otherBuffer - another double buffer.other; 0 if this
equals to other; a positive value if this is greater
than other.ClassCastException - if other is not a double buffer.public abstract DoubleBuffer duplicate()
The duplicated buffer's position, limit, capacity and mark are the same as this buffer's. The duplicated buffer's read-only property and byte order are the same as this buffer's, too.
The new buffer shares its content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
public boolean equals(Object other)
If other is not a double buffer then false is returned.
Two double buffers are equal if and only if their remaining doubles are
exactly the same. Position, limit, capacity and mark are not considered.
public abstract double get()
BufferUnderflowException - if the position is equal or greater than limit.public DoubleBuffer get(double[] dest)
Calling this method has the same effect as
get(dest, 0, dest.length).
dest - the destination double array.BufferUnderflowException - if dest.length is greater than remaining().public DoubleBuffer get(double[] dest, int off, int len)
dest - the target double array.off - the offset of the double array, must not be negative and not
greater than dest.length.len - the number of doubles to read, must be no less than zero and
not greater than dest.length - off.IndexOutOfBoundsException - if either off or len is invalid.BufferUnderflowException - if len is greater than remaining().public abstract double get(int index)
index - the index, must not be negative and less than limit.IndexOutOfBoundsException - if index is invalid.public final boolean hasArray()
true if this buffer is based on a double array and
provides read/write access, false otherwise.public int hashCode()
public abstract boolean isDirect()
A double buffer is direct if it is based on a byte buffer and the byte buffer is direct.
true if this buffer is direct, false otherwise.public abstract ByteOrder order()
If this buffer is not based on a byte buffer, then this always returns the platform's native byte order.
public abstract DoubleBuffer put(double d)
d - the double to write.BufferOverflowException - if position is equal or greater than limit.ReadOnlyBufferException - if no changes may be made to the contents of this buffer.public final DoubleBuffer put(double[] src)
Calling this method has the same effect as
put(src, 0, src.length).
src - the source double array.BufferOverflowException - if remaining() is less than src.length.ReadOnlyBufferException - if no changes may be made to the contents of this buffer.public DoubleBuffer put(double[] src, int off, int len)
src - the source double array.off - the offset of double array, must not be negative and not
greater than src.length.len - the number of doubles to write, must be no less than zero and
not greater than src.length - off.BufferOverflowException - if remaining() is less than len.IndexOutOfBoundsException - if either off or len is invalid.ReadOnlyBufferException - if no changes may be made to the contents of this buffer.public DoubleBuffer put(DoubleBuffer src)
src double buffer to this
buffer's current position, and increases both buffers' position by the
number of doubles copied.src - the source double buffer.BufferOverflowException - if src.remaining() is greater than this buffer's
remaining().IllegalArgumentException - if src is this buffer.ReadOnlyBufferException - if no changes may be made to the contents of this buffer.public abstract DoubleBuffer put(int index, double d)
index - the index, must not be negative and less than the limit.d - the double to write.IndexOutOfBoundsException - if index is invalid.ReadOnlyBufferException - if no changes may be made to the contents of this buffer.public abstract DoubleBuffer slice()
The sliced buffer's capacity will be this buffer's remaining(),
and its zero position will correspond to this buffer's current position.
The new buffer's position will be 0, limit will be its capacity, and its
mark is cleared. The new buffer's read-only property and byte order are
the same as this buffer's.
The new buffer shares its content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
Copyright © 2020 Dmitrii Tikhomirov. All rights reserved.