java.nio
public
abstract
class
java.nio.FloatBuffer
A buffer of float
s.
A float buffer can be created in either of the following ways:
- Allocate a new float array and create a buffer
based on it;
- Wrap an existing float array to create a new
buffer;
- Use ByteBuffer.asFloatBuffer
to create a float buffer based on a byte buffer.
Summary
Public Methods
capacity,
clear,
flip,
hasRemaining,
isReadOnly,
limit,
limit,
mark,
position,
position,
remaining,
reset,
rewind
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Public Methods
public
static
FloatBuffer
allocate(int capacity)
Creates a float buffer based on a new allocated float array.
Parameters
capacity
| The capacity of the new buffer |
public
final
float[]
array()
Returns the float array which this buffer is based on, if there's one.
Returns
- The float array which this buffer is based on
public
final
int
arrayOffset()
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.
Returns
- The offset of the float array which this buffer is based on
public
abstract
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. 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.
Returns
- A readonly version of this buffer.
public
abstract
FloatBuffer
compact()
Compacts this float buffer.
The remaining float
s 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.
public
int
compareTo(FloatBuffer otherBuffer)
Compare the remaining
float
s of this buffer to another
float buffer's remaining
float
s.
Parameters
otherBuffer
| Another float buffer |
Returns
- a negative value if this is less than
other
; 0 if
this equals to other
; a positive value if this is
greater than other
public
abstract
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. 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.
Returns
- A duplicated buffer that shares content with 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
float
s are exactly the same. Position, limit, capacity and
mark are not considered.
Parameters
other
| the object to be compared against |
Returns
- Whether this float buffer equals to another object.
public
abstract
float
get()
Returns the float at the current position and increase the position by 1.
Returns
- The float at the current position.
public
FloatBuffer
get(float[] dest, int off, int len)
Reads
float
s from the current position into the specified
float array, starting from the specified offset, and increase the
position by the number of
float
s read.
Parameters
dest
| The target float array |
off
| The offset of the float array, must be no less than zero and
no greater than dest.length |
len
| The number of float s to read, must be no less
than zero and no greater than dest.length - off |
public
abstract
float
get(int index)
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 |
Returns
- A float at the specified index.
public
FloatBuffer
get(float[] dest)
Reads
float
s from the current position into the specified
float array and increase the position by the number of
float
s
read.
Calling this method has the same effect as
get(dest, 0, dest.length)
.
Parameters
dest
| The destination float array |
public
final
boolean
hasArray()
Returns whether this buffer is based on a float array and is read/write.
If this buffer is readonly, then false is returned.
Returns
- Whether this buffer is based on a float array and is read/write.
public
int
hashCode()
Hash code is calculated from the remaining
float
s.
Position, limit, capacity and mark don't affect the hash code.
Returns
- The hash code calculated from the remaining
float
s.
public
abstract
boolean
isDirect()
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.
Returns
- True if this buffer is direct.
public
abstract
ByteOrder
order()
Returns the byte order used by this buffer when converting
float
s from/to
byte
s.
If this buffer is not based on a byte buffer, then always return the
platform's native byte order.
Returns
- The byte order used by this buffer when converting
float
s from/to byte
s.
public
abstract
FloatBuffer
put(float f)
Writes the given float to the current position and increase the position
by 1.
Writes all the remaining
float
s of the
src
float buffer to this buffer's current position, and increase both
buffers' position by the number of
float
s copied.
Parameters
src
| The source float buffer |
public
FloatBuffer
put(float[] src, int off, int len)
Writes
float
s in the given float array, starting from the
specified offset, to the current position and increase the position by
the number of
float
s written.
Parameters
src
| The source float array |
off
| The offset of float array, must be no less than zero and no
greater than src.length |
len
| The number of float s to write, must be no less
than zero and no greater than src.length - off |
public
abstract
FloatBuffer
put(int index, float f)
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 |
f
| The float to write |
public
final
FloatBuffer
put(float[] src)
Writes
float
s in the given float array to the current
position and increase the position by the number of
float
s
written.
Calling this method has the same effect as
put(src, 0, src.length)
.
Parameters
src
| The source float array |
public
abstract
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. 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.
Returns
- A sliced buffer that shares content with this buffer.
public
String
toString()
Returns a string represents the state of this float buffer.
Returns
- A string represents the state of this float buffer.
public
static
FloatBuffer
wrap(float[] array, int start, int len)
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 |
start
| The start index, must be no less than zero and no greater than
array.length |
len
| The length, must be no less than zero and no greater than
array.length - start |
public
static
FloatBuffer
wrap(float[] array)
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 |