| java.lang.Object
 java.nio.Buffer
java.nio.DoubleBuffer
All known Subclasses: java.nio.DoubleArrayBuffer, java.nio.DoubleToByteBufferAdapter,
| DoubleBuffer | | abstract public class DoubleBuffer extends Buffer implements Comparable<DoubleBuffer>(Code) | | A buffer of doubles.
A double buffer can be created in either of the following ways:
|
| Constructor Summary | |
| | DoubleBuffer(int capacity)
Constructs a DoubleBuffer with given capacity. |
| Method Summary | |
| public static DoubleBuffer | allocate(int capacity)
Creates a double buffer based on a new allocated double array. | | final public double[] | array()
Returns the double array which this buffer is based on, if there's one. | | final public int | arrayOffset()
Returns the offset of the double array which this buffer is based on, if
there's one. | | abstract public DoubleBuffer | asReadOnlyBuffer()
Returns a readonly buffer that shares content with this buffer.
The returned buffer is guaranteed to be a new instance, even this buffer
is readonly itself. | | abstract public DoubleBuffer | compact()
Compacts this double buffer.
The remaining doubles will be moved to the head of the
buffer, staring from position zero. | | public int | compareTo(DoubleBuffer otherBuffer)
Compare the remaining doubles of this buffer to another
double buffer's remaining doubles. | | abstract public DoubleBuffer | duplicate()
Returns a duplicated buffer that shares content with this buffer.
The duplicated buffer's position, limit, capacity and mark are the same
as this buffer. | | public boolean | equals(Object other)
Tests whether this double buffer equals to another object.
If other is not a double buffer, then false is returned.
Two double buffers are equals if, and only if, their remaining
doubles are exactly the same. | | abstract public double | get()
Returns the double at the current position and increase the position by
1. | | public DoubleBuffer | get(double[] dest)
Reads doubles from the current position into the
specified double array and increase the position by the number of
doubles read. | | public 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 increase
the position by the number of doubles read. | | abstract public double | get(int index)
Returns a double at the specified index, and the position is not changed. | | final public boolean | hasArray()
Returns whether this buffer is based on a double array and is read/write. | | public int | hashCode()
Hash code is calculated from the remaining doubles. | | abstract public boolean | isDirect()
Returns true if this buffer is direct. | | abstract public ByteOrder | order()
Returns the byte order used by this buffer when converting
doubles from/to bytes. | | abstract double[] | protectedArray()
Child class implements this method to realize array(). | | abstract int | protectedArrayOffset()
Child class implements this method to realize arrayOffset(). | | abstract boolean | protectedHasArray()
Child class implements this method to realize hasArray(). | | abstract public DoubleBuffer | put(double d)
Writes the given double to the current position and increase the position
by 1. | | final public DoubleBuffer | put(double[] src)
Writes doubles in the given double array to the current
position and increase the position by the number of doubles
written. | | public DoubleBuffer | put(double[] src, int off, int len)
Writes doubles in the given double array, starting from
the specified offset, to the current position and increase the position
by the number of doubles written. | | public DoubleBuffer | put(DoubleBuffer src)
Writes all the remaining doubles of the src
double buffer to this buffer's current position, and increase both
buffers' position by the number of doubles copied. | | abstract public DoubleBuffer | put(int index, double d)
Write a double to the specified index of this buffer and the position is
not changed. | | abstract public DoubleBuffer | slice()
Returns a sliced buffer that shares content with this buffer.
The sliced buffer's capacity will be this buffer's
remaining(), and its zero position will correspond to
this buffer's current position. | | public String | toString()
Returns a string represents the state of this double buffer. | | public static DoubleBuffer | wrap(double[] array)
Creates a new double buffer by wrapping the given double array. | | public static DoubleBuffer | wrap(double[] array, int start, int len)
Creates new a double buffer by wrapping the given double array. |
| DoubleBuffer | | DoubleBuffer(int capacity)(Code) | | Constructs a DoubleBuffer with given capacity.
Parameters:
capacity - The capacity of the buffer |
| allocate | | public static DoubleBuffer allocate(int capacity)(Code) | | Creates a double buffer based on a new allocated double array.
Parameters:
capacity - The capacity of the new buffer The created double buffer
throws:
IllegalArgumentException - If capacity is less than zero |
| array | | final public double[] array()(Code) | | Returns the double array which this buffer is based on, if there's one.
The double array which this buffer is based on
exception:
ReadOnlyBufferException - If this buffer is based on an array, but it is readonly
exception:
UnsupportedOperationException - If this buffer is not based on an array |
| arrayOffset | | final public int arrayOffset()(Code) | | Returns the offset of the double array which this buffer is based on, if
there's one.
The offset is the index of the array corresponds to the zero position of
the buffer.
The offset of the double array which this buffer is based on
exception:
ReadOnlyBufferException - If this buffer is based on an array, but it is readonly
exception:
UnsupportedOperationException - If this buffer is not based on an array |
| asReadOnlyBuffer | | abstract public DoubleBuffer asReadOnlyBuffer()(Code) | | Returns a readonly buffer that shares content with this buffer.
The returned buffer is guaranteed to be a new instance, even this buffer
is readonly itself. The new buffer's position, limit, capacity and mark
are the same as this buffer.
The new buffer shares content with this buffer, which means this buffer's
change of content will be visible to the new buffer. The two buffer's
position, limit and mark are independent.
A readonly version of this buffer. |
| compact | | abstract public DoubleBuffer compact()(Code) | | Compacts this double buffer.
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.
This buffer
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| compareTo | | public int compareTo(DoubleBuffer otherBuffer)(Code) | | Compare the remaining doubles of this buffer to another
double buffer's remaining doubles.
Parameters:
otherBuffer - Another double buffer a negative value if this is less than other; 0 ifthis equals to other; a positive value if this isgreater than other
exception:
ClassCastException - If other is not a double buffer |
| duplicate | | abstract public DoubleBuffer duplicate()(Code) | | Returns a duplicated buffer that shares content with this buffer.
The duplicated buffer's position, limit, capacity and mark are the same
as this buffer. The duplicated buffer's readonly property and byte order
are same as this buffer too.
The new buffer shares 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.
A duplicated buffer that shares content with this buffer. |
| equals | | public boolean equals(Object other)(Code) | | Tests whether this double buffer equals to another object.
If other is not a double buffer, then false is returned.
Two double buffers are equals if, and only if, their remaining
doubles are exactly the same. Position, limit, capacity
and mark are not considered.
Parameters:
other - the object to be compared against Whether this double buffer equals to another object. |
| get | | abstract public double get()(Code) | | Returns the double at the current position and increase the position by
1.
The double at the current position.
exception:
BufferUnderflowException - If the position is equal or greater than limit |
| get | | public DoubleBuffer get(double[] dest)(Code) | | Reads doubles from the current position into the
specified double array and increase the position by the number of
doubles read.
Calling this method has the same effect as
get(dest, 0, dest.length).
Parameters:
dest - The destination double array This buffer
exception:
BufferUnderflowException - if dest.length is greater thanremaining() |
| get | | public DoubleBuffer get(double[] dest, int off, int len)(Code) | | Reads doubles from the current position into the
specified double array, starting from the specified offset, and increase
the position by the number of doubles read.
Parameters:
dest - The target double array
Parameters:
off - The offset of the double array, must be no less than zero andno greater than dest.length
Parameters:
len - The number of doubles to read, must be no lessthan zero and no greater than dest.length - off This buffer
exception:
IndexOutOfBoundsException - If either off or len isinvalid
exception:
BufferUnderflowException - If len is greater thanremaining() |
| get | | abstract public double get(int index)(Code) | | Returns a double at the specified index, and the position is not changed.
Parameters:
index - The index, must be no less than zero and less than limit A double at the specified index.
exception:
IndexOutOfBoundsException - If index is invalid |
| hasArray | | final public boolean hasArray()(Code) | | Returns whether this buffer is based on a double array and is read/write.
If this buffer is readonly, then false is returned.
Whether this buffer is based on a double array and is read/write. |
| hashCode | | public int hashCode()(Code) | | Hash code is calculated from the remaining doubles.
Position, limit, capacity and mark don't affect the hash code.
The hash code calculated from the remaining doubles. |
| isDirect | | abstract public boolean isDirect()(Code) | | Returns true if this buffer is direct.
A direct buffer will try its best to take advantage of native memory APIs
and it may not stay in java heap, thus not affected by GC.
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. |
| order | | abstract public ByteOrder order()(Code) | | Returns the byte order used by this buffer when converting
doubles from/to bytes.
If this buffer is not based on a byte buffer, then always return the
platform's native byte order.
The byte order used by this buffer when convertingdoubles from/to bytes. |
| protectedArray | | abstract double[] protectedArray()(Code) | | Child class implements this method to realize array().
see array() |
| protectedArrayOffset | | abstract int protectedArrayOffset()(Code) | | Child class implements this method to realize arrayOffset().
see arrayOffset() |
| protectedHasArray | | abstract boolean protectedHasArray()(Code) | | Child class implements this method to realize hasArray().
see hasArray() |
| put | | abstract public DoubleBuffer put(double d)(Code) | | Writes the given double to the current position and increase the position
by 1.
Parameters:
d - The double to write This buffer
exception:
BufferOverflowException - If position is equal or greater than limit
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | final public DoubleBuffer put(double[] src)(Code) | | Writes doubles in the given double array to the current
position and increase the position by the number of doubles
written.
Calling this method has the same effect as
put(src, 0, src.length).
Parameters:
src - The source double array This buffer
exception:
BufferOverflowException - If remaining() is less thansrc.length
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | public DoubleBuffer put(double[] src, int off, int len)(Code) | | Writes doubles in the given double array, starting from
the specified offset, to the current position and increase the position
by the number of doubles written.
Parameters:
src - The source double array
Parameters:
off - The offset of double array, must be no less than zero and nogreater than src.length
Parameters:
len - The number of doubles to write, must be noless than zero and no greater thansrc.length - off This buffer
exception:
BufferOverflowException - If remaining() is less thanlen
exception:
IndexOutOfBoundsException - If either off or len isinvalid
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | public DoubleBuffer put(DoubleBuffer src)(Code) | | Writes all the remaining doubles of the src
double buffer to this buffer's current position, and increase both
buffers' position by the number of doubles copied.
Parameters:
src - The source double buffer This buffer
exception:
BufferOverflowException - If src.remaining() is greater than thisbuffer's remaining()
exception:
IllegalArgumentException - If src is this buffer
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | abstract public DoubleBuffer put(int index, double d)(Code) | | Write a double to the specified index of this buffer and the position is
not changed.
Parameters:
index - The index, must be no less than zero and less than the limit
Parameters:
d - The double to write This buffer
exception:
IndexOutOfBoundsException - If index is invalid
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| slice | | abstract public DoubleBuffer slice()(Code) | | Returns a sliced buffer that shares content with this buffer.
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 unset. The new buffer's
readonly property and byte order are same as this buffer.
The new buffer shares 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.
A sliced buffer that shares content with this buffer. |
| toString | | public String toString()(Code) | | Returns a string represents the state of this double buffer.
A string represents the state of this double buffer. |
| wrap | | public static DoubleBuffer wrap(double[] array)(Code) | | Creates a new double buffer by wrapping the given double array.
Calling this method has the same effect as
wrap(array, 0, array.length).
Parameters:
array - The double array which the new buffer will be based on The created double buffer |
| wrap | | public static DoubleBuffer wrap(double[] array, int start, int len)(Code) | | Creates new a double buffer by wrapping the given double array.
The new buffer's position will be start, limit will be
start + len, capacity will be the length of the array.
Parameters:
array - The double array which the new buffer will be based on
Parameters:
start - The start index, must be no less than zero and no greater thanarray.length
Parameters:
len - The length, must be no less than zero and no greater thanarray.length - start The created double buffer
exception:
IndexOutOfBoundsException - If either start or len isinvalid |
|
|