java.nio.Buffer
java.nio.FloatBuffer
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public abstract class FloatBuffer
A float buffer.
This class is provided as part of the JSR 239 NIO Buffer building
block. It is a subset of the java.nio.FloatBuffer
class in Java(TM) Standard Edition version 1.4.2. Differences are
noted in bold italic. The class documentation may
make reference to classes that are not present in the building
block.
I/O channels, marking and resetting, and read-only buffers are not supported. Allocation of non-direct float buffers, compaction, and duplication are not supported. The following methods are omitted:
FloatBuffer allocate(int capacity)FloatBuffer compact()FloatBuffer duplicate()Buffer mark()Buffer reset()boolean isReadOnly()FloatBuffer asReadOnlyBuffer()This class defines four categories of operations upon float buffers:
Absolute and relative get and
put methods that read and
write single floats;
Relative bulk get
methods that transfer contiguous sequences of floats from this
buffer into an array;
Relative bulk put
methods that transfer contiguous sequences of floats from a float
array or some other float buffer into this buffer; and
Methods for compacting, duplicating, and slicing a
float buffer. JSR 239 does not support compacting and
duplicating buffers.
Float buffers can be created either by allocation, which
allocates space for the buffer's content, by wrapping an existing float array into a
buffer, or by creating a view of an
existing byte buffer. JSR 239 supports allocation of
ByteBuffers only.
Like a byte buffer, a float buffer is either
direct or non-direct. A
float buffer created via the wrap methods of this class
will be non-direct. A float 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 float 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.
| Method Summary | ||
|---|---|---|
float[] |
array()
Returns the float array that backs this buffer (optional operation). |
|
int |
arrayOffset()
Returns the offset within this buffer's backing array of the first element of the buffer (optional operation). |
|
int |
compareTo(Object ob)
Compares this buffer to another. |
|
boolean |
equals(Object ob)
Tells whether or not this buffer is equal to another object. |
|
abstract float |
get()
Relative get method. |
|
FloatBuffer |
get(float[] dst)
Relative bulk get method. |
|
FloatBuffer |
get(float[] dst,
int offset,
int length)
Relative bulk get method. |
|
abstract float |
get(int index)
Absolute get method. |
|
boolean |
hasArray()
Tells whether or not this buffer is backed by an accessible float array. |
|
int |
hashCode()
Returns the current hash code of this buffer. |
|
abstract boolean |
isDirect()
Tells whether or not this float buffer is direct. |
|
abstract FloatBuffer |
put(float f)
Relative put method (optional operation). |
|
FloatBuffer |
put(float[] src)
Relative bulk put method (optional operation). |
|
FloatBuffer |
put(float[] src,
int offset,
int length)
Relative bulk put method (optional operation). |
|
abstract FloatBuffer |
put(int index,
float f)
Absolute put method (optional operation). |
|
FloatBuffer |
put(FloatBuffer src)
Relative bulk put method (optional operation). |
|
abstract FloatBuffer |
slice()
Creates a new float buffer whose content is a shared subsequence of this buffer's content. |
|
String |
toString()
Returns a string summarizing the state of this buffer. |
|
static FloatBuffer |
wrap(float[] array)
Wraps a float array into a buffer. |
|
static FloatBuffer |
wrap(float[] array,
int offset,
int length)
Wraps a float array into a buffer. |
|
| Methods inherited from class java.nio.Buffer |
|---|
capacity, clear, flip, hasRemaining, limit, limit, position, position, remaining, rewind |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, wait, wait, wait |
| Method Detail |
|---|
public static FloatBuffer wrap(float[] array,
int offset,
int length)
The new buffer will be backed by the given float 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.
array - The array that will back the new buffer.offset - 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 - The length of the subarray to be used; must be
non-negative and no larger thanoffset. The new
buffer's limit will be set to offset + length.
IndexOutOfBoundsException - If the preconditions on the
offset and length parameters do not holdpublic static FloatBuffer wrap(float[] array)
The new buffer will be backed by the given float 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.
array - The array that will back this buffer
public abstract FloatBuffer slice()
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. JSR 239 does not support the mark.
The new buffer's position will be zero, its capacity and its limit will be the number of floats 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. JSR 239 does not support the mark or read-only buffers.
public abstract float get()
BufferUnderflowException - If the buffer's current
position is not smaller than its limit.public abstract FloatBuffer put(float f)
Writes the given float into this buffer at the current position, and then increments the position.
f - The float to be written.
BufferOverflowException - If this buffer's current
position is not smaller than its limit.
ReadOnlyBufferException - If this buffer is read-only.
JSR 239 does not support read-only buffer or
the ReadOnlyBufferException class.public abstract float get(int index)
index - The index from which the float will be read.
IndexOutOfBoundsException - If index
is negative or not smaller than the buffer's limit.
public abstract FloatBuffer put(int index,
float f)
Writes the given float into this buffer at the given index.
index - The index at which the float will be written.f - The float value to be written.
IndexOutOfBoundsException - If index
is negative or not smaller than the buffer's limit.
ReadOnlyBufferException - If this buffer is read-only.
JSR 239 does not support read-only buffer or
the ReadOnlyBufferException class.
public FloatBuffer get(float[] dst,
int offset,
int length)
This method transfers floats from this buffer into the given
destination array. If there are fewer floats remaining in the
buffer than are required to satisfy the request, that is, if
length > remaining(),
then no floats are transferred and a
BufferUnderflowException is thrown.
Otherwise, this method copies length floats 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 floats in
this buffer and it is potentially much more efficient.
dst - The array into which floats are to be written.offset - The offset within the array of the first float to
be written; must be non-negative and no larger than dst.length.length - The maximum number of floats to be written to the
given array; must be non-negative and no larger than dst.length - offset.
BufferUnderflowException - If there are fewer than
dst.length floats remaining in this buffer.
IndexOutOfBoundsException - If the
preconditions on the offset and length parameters
do not hold.public FloatBuffer get(float[] dst)
This method transfers floats from this buffer into the given destination array. An invocation of this method of the form src.get(a) behaves in exactly the same way as the invocation
src.get(a, 0, a.length)
BufferUnderflowException - If there are fewer than
length floats remaining in this buffer.public FloatBuffer put(FloatBuffer src)
This method transfers the floats remaining in the given source
buffer into this buffer. If there are more floats remaining in
the source buffer than in this buffer, that is, if
src.remaining() >
remaining(), then no floats are transferred and a
BufferOverflowException is thrown.
Otherwise, this method copies n = src.remaining() floats 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.
src - The source buffer from which floats are to be read;
must not be this buffer.
BufferOverflowException - If there is insufficient space
in this buffer for the remaining floats in the source buffer.
IllegalArgumentException - If the source buffer
is this buffer.
ReadOnlyBufferException - If this buffer is read-only.
JSR 239 does not support read-only buffer or
the ReadOnlyBufferException class.
public FloatBuffer put(float[] src,
int offset,
int length)
This method transfers floats into this buffer from the given
source array. If there are more floats to be copied from the
array than remain in this buffer, that is, if length
> remaining(), then no floats
are transferred and a BufferOverflowException is
thrown.
Otherwise, this method copies length floats 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.
src - The array from which floats are to be read.offset - The offset within the array of the first float to
be read; must be non-negative and no larger than array.length.length - The number of floats to be read from the given
array; must be non-negative and no larger than array.length - offset.
BufferOverflowException - If there is insufficient space in this buffer.
IndexOutOfBoundsException - If the preconditions on the offset
and length parameters do not hold.
ReadOnlyBufferException - If this buffer is read-only.
JSR 239 does not support read-only buffer or
the ReadOnlyBufferException class.public final FloatBuffer put(float[] src)
This method transfers the entire content of the given source float array into this buffer. An invocation of this method of the form dst.put(a) behaves in exactly the same way as the invocation
dst.put(a, 0, a.length)
BufferOverflowException - If there is insufficient space in this buffer.
ReadOnlyBufferException - If this buffer is read-only.
JSR 239 does not support read-only buffer or the
ReadOnlyBufferException class.public final boolean hasArray()
If this method returns true then the array and arrayOffset methods may
safely be invoked.
public final float[] array()
Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa.
Invoke the hasArray method before invoking
this method in order to ensure that this buffer has an
accessible backing array.
ReadOnlyBufferException - If this buffer is read-only.
JSR 239 does not support read-only buffer or
the ReadOnlyBufferException class.
UnsupportedOperationException - If this buffer is not
backed by an accessible array.public final int arrayOffset()
If this buffer is backed by an array then buffer position p corresponds to array index p + arrayOffset().
Invoke the hasArray method before invoking
this method in order to ensure that this buffer has an
accessible backing array.
ReadOnlyBufferException - If this buffer is read-only.
JSR 239 does not support read-only buffer or
the ReadOnlyBufferException class.
UnsupportedOperationException - If this buffer is not
backed by an accessible array.public abstract boolean isDirect()
public String toString()
toString in class Objectpublic int hashCode()
The hash code of a float buffer depends only upon its remaining elements; that is, upon the elements from position() up to, and including, the element at limit() - 1.
Because buffer hash codes are content-dependent, it is inadvisable to use buffers as keys in hash maps or similar data structures unless it is known that their contents will not change.
hashCode in class ObjectObject.equals(Object),
Hashtablepublic boolean equals(Object ob)
Two float buffers are equal if, and only if,
They have the same element type,
They have the same number of remaining elements, and
The two sequences of remaining elements, considered independently of their starting positions, are pointwise equal.
A float buffer is not equal to any other type of object.
equals in class Objectob - The object to which this buffer is to be compared.
Boolean.hashCode(),
Hashtablepublic int compareTo(Object ob)
Two float buffers are compared by comparing their sequences of remaining elements lexicographically, without regard to the starting position of each sequence within its corresponding buffer.
A float buffer is not comparable to any other type of object.
compareTo in interface Comparableob - the Object to be compared.
ClassCastException - If the argument is not a
float buffer.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal