| java.lang.Object
 java.nio.Buffer
java.nio.FloatBuffer
All known Subclasses: java.nio.FloatToByteBufferAdapter, java.nio.FloatArrayBuffer,
| FloatBuffer | | abstract public class FloatBuffer extends Buffer implements Comparable<FloatBuffer>(Code) | | A buffer of floats.
A float buffer can be created in either of the following ways:
|
| Constructor Summary | |
| | FloatBuffer(int capacity)
Constructs a FloatBuffer with given capacity. |
| Method Summary | |
| public static FloatBuffer | allocate(int capacity)
Creates a float buffer based on a new allocated float array. | | final public float[] | array()
Returns the float array which this buffer is based on, if there's one. | | final public int | arrayOffset()
Returns the offset of the float array which this buffer is based on, if
there's one. | | abstract public FloatBuffer | 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 FloatBuffer | compact()
Compacts this float buffer.
The remaining floats will be moved to the head of the
buffer, staring from position zero. | | public int | compareTo(FloatBuffer otherBuffer)
Compare the remaining floats of this buffer to another
float buffer's remaining floats. | | abstract public FloatBuffer | 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 float buffer equals to another object.
If other is not a float buffer, then false is returned.
Two float buffers are equals if, and only if, their remaining
floats are exactly the same. | | abstract public float | get()
Returns the float at the current position and increase the position by 1. | | public FloatBuffer | get(float[] dest)
Reads floats from the current position into the specified
float array and increase the position by the number of floats
read. | | public FloatBuffer | get(float[] dest, int off, int len)
Reads floats from the current position into the specified
float array, starting from the specified offset, and increase the
position by the number of floats read. | | abstract public float | get(int index)
Returns a float at the specified index, and the position is not changed. | | final public boolean | hasArray()
Returns whether this buffer is based on a float array and is read/write. | | public int | hashCode()
Hash code is calculated from the remaining floats. | | 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
floats from/to bytes. | | abstract float[] | 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 FloatBuffer | put(float f)
Writes the given float to the current position and increase the position
by 1. | | final public FloatBuffer | put(float[] src)
Writes floats in the given float array to the current
position and increase the position by the number of floats
written. | | public FloatBuffer | put(float[] src, int off, int len)
Writes floats in the given float array, starting from the
specified offset, to the current position and increase the position by
the number of floats written. | | public FloatBuffer | put(FloatBuffer src)
Writes all the remaining floats of the src
float buffer to this buffer's current position, and increase both
buffers' position by the number of floats copied. | | abstract public FloatBuffer | put(int index, float f)
Write a float to the specified index of this buffer and the position is
not changed. | | abstract public FloatBuffer | 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 float buffer. | | public static FloatBuffer | wrap(float[] array)
Creates a new float buffer by wrapping the given float array. | | public static FloatBuffer | wrap(float[] array, int start, int len)
Creates new a float buffer by wrapping the given float array. |
| FloatBuffer | | FloatBuffer(int capacity)(Code) | | Constructs a FloatBuffer with given capacity.
Parameters:
capacity - The capacity of the buffer |
| allocate | | public static FloatBuffer allocate(int capacity)(Code) | | Creates a float buffer based on a new allocated float array.
Parameters:
capacity - The capacity of the new buffer The created float buffer
throws:
IllegalArgumentException - If capacity is less than zero |
| array | | final public float[] array()(Code) | | Returns the float array which this buffer is based on, if there's one.
The float 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 float 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 float 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 FloatBuffer 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 FloatBuffer compact()(Code) | | Compacts this float buffer.
The remaining floats 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(FloatBuffer otherBuffer)(Code) | | Compare the remaining floats of this buffer to another
float buffer's remaining floats.
Parameters:
otherBuffer - Another float 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 float buffer |
| duplicate | | abstract public FloatBuffer 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 float buffer equals to another object.
If other is not a float buffer, then false is returned.
Two float buffers are equals if, and only if, their remaining
floats are exactly the same. Position, limit, capacity
and mark are not considered.
Parameters:
other - the object to be compared against Whether this float buffer equals to another object. |
| get | | abstract public float get()(Code) | | Returns the float at the current position and increase the position by 1.
The float at the current position.
exception:
BufferUnderflowException - If the position is equal or greater than limit |
| get | | public FloatBuffer get(float[] dest)(Code) | | Reads floats from the current position into the specified
float array and increase the position by the number of floats
read.
Calling this method has the same effect as
get(dest, 0, dest.length).
Parameters:
dest - The destination float array This buffer
exception:
BufferUnderflowException - if dest.length is greater thanremaining() |
| get | | public FloatBuffer get(float[] dest, int off, int len)(Code) | | Reads floats from the current position into the specified
float array, starting from the specified offset, and increase the
position by the number of floats read.
Parameters:
dest - The target float array
Parameters:
off - The offset of the float array, must be no less than zero andno greater than dest.length
Parameters:
len - The number of floats 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 float get(int index)(Code) | | Returns a float 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 float at the specified index.
exception:
IndexOutOfBoundsException - If index is invalid |
| hasArray | | final public boolean hasArray()(Code) | | Returns whether this buffer is based on a float array and is read/write.
If this buffer is readonly, then false is returned.
Whether this buffer is based on a float array and is read/write. |
| hashCode | | public int hashCode()(Code) | | Hash code is calculated from the remaining floats.
Position, limit, capacity and mark don't affect the hash code.
The hash code calculated from the remaining floats. |
| 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 float 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
floats 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 convertingfloats from/to bytes. |
| protectedArray | | abstract float[] 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 FloatBuffer put(float f)(Code) | | Writes the given float to the current position and increase the position
by 1.
Parameters:
f - The float 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 FloatBuffer put(float[] src)(Code) | | Writes floats in the given float array to the current
position and increase the position by the number of floats
written.
Calling this method has the same effect as
put(src, 0, src.length).
Parameters:
src - The source float 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 FloatBuffer put(float[] src, int off, int len)(Code) | | Writes floats in the given float array, starting from the
specified offset, to the current position and increase the position by
the number of floats written.
Parameters:
src - The source float array
Parameters:
off - The offset of float array, must be no less than zero and nogreater than src.length
Parameters:
len - The number of floats to write, must be no lessthan zero and no greater than src.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 FloatBuffer put(FloatBuffer src)(Code) | | Writes all the remaining floats of the src
float buffer to this buffer's current position, and increase both
buffers' position by the number of floats copied.
Parameters:
src - The source float 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 FloatBuffer put(int index, float f)(Code) | | Write a float 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:
f - The float 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 FloatBuffer 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 float buffer.
A string represents the state of this float buffer. |
| wrap | | public static FloatBuffer wrap(float[] array)(Code) | | Creates a new float buffer by wrapping the given float array.
Calling this method has the same effect as
wrap(array, 0, array.length).
Parameters:
array - The float array which the new buffer will be based on The created float buffer |
| wrap | | public static FloatBuffer wrap(float[] array, int start, int len)(Code) | | Creates new a float buffer by wrapping the given float 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 float 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 float buffer
exception:
IndexOutOfBoundsException - If either start or len isinvalid |
|
|