java.nio
Class FloatBuffer

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.nio.Buffer sample code for java.nio.Buffer definition code for java.nio.Buffer 
      extended by java.nio.FloatBuffer
All Implemented Interfaces:
Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer >

public abstract class FloatBuffer
extends Buffer sample code for java.nio.Buffer definition code for java.nio.Buffer
implements Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer >

A float buffer.

This class defines four categories of operations upon float buffers:

Float buffers can be created either by allocation sample code for java.nio.FloatBuffer.allocate(int) definition code for java.nio.FloatBuffer.allocate(int) , which allocates space for the buffer's content, by wrapping sample code for java.nio.FloatBuffer.wrap(float[]) definition code for java.nio.FloatBuffer.wrap(float[]) an existing float array into a buffer, or by creating a view of an existing byte buffer

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 sample code for java.nio.FloatBuffer.isDirect() definition code for java.nio.FloatBuffer.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.

Since:
1.4

Method Summary
static FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer allocate sample code for java.nio.FloatBuffer.allocate(int) definition code for java.nio.FloatBuffer.allocate(int) (int capacity)
          Allocates a new float buffer.
 float[] array sample code for java.nio.FloatBuffer.array() definition code for java.nio.FloatBuffer.array() ()
          Returns the float array that backs this buffer  (optional operation).
 int arrayOffset sample code for java.nio.FloatBuffer.arrayOffset() definition code for java.nio.FloatBuffer.arrayOffset() ()
          Returns the offset within this buffer's backing array of the first element of the buffer  (optional operation).
abstract  FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer asReadOnlyBuffer sample code for java.nio.FloatBuffer.asReadOnlyBuffer() definition code for java.nio.FloatBuffer.asReadOnlyBuffer() ()
          Creates a new, read-only float buffer that shares this buffer's content.
abstract  FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer compact sample code for java.nio.FloatBuffer.compact() definition code for java.nio.FloatBuffer.compact() ()
          Compacts this buffer  (optional operation).
 int compareTo sample code for java.nio.FloatBuffer.compareTo(java.nio.FloatBuffer) definition code for java.nio.FloatBuffer.compareTo(java.nio.FloatBuffer) (FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  that)
          Compares this buffer to another.
abstract  FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer duplicate sample code for java.nio.FloatBuffer.duplicate() definition code for java.nio.FloatBuffer.duplicate() ()
          Creates a new float buffer that shares this buffer's content.
 boolean equals sample code for java.nio.FloatBuffer.equals(java.lang.Object) definition code for java.nio.FloatBuffer.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  ob)
          Tells whether or not this buffer is equal to another object.
abstract  float get sample code for java.nio.FloatBuffer.get() definition code for java.nio.FloatBuffer.get() ()
          Relative get method.
 FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer get sample code for java.nio.FloatBuffer.get(float[]) definition code for java.nio.FloatBuffer.get(float[]) (float[] dst)
          Relative bulk get method.
 FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer get sample code for java.nio.FloatBuffer.get(float[], int, int) definition code for java.nio.FloatBuffer.get(float[], int, int) (float[] dst, int offset, int length)
          Relative bulk get method.
abstract  float get sample code for java.nio.FloatBuffer.get(int) definition code for java.nio.FloatBuffer.get(int) (int index)
          Absolute get method.
 boolean hasArray sample code for java.nio.FloatBuffer.hasArray() definition code for java.nio.FloatBuffer.hasArray() ()
          Tells whether or not this buffer is backed by an accessible float array.
 int hashCode sample code for java.nio.FloatBuffer.hashCode() definition code for java.nio.FloatBuffer.hashCode() ()
          Returns the current hash code of this buffer.
abstract  boolean isDirect sample code for java.nio.FloatBuffer.isDirect() definition code for java.nio.FloatBuffer.isDirect() ()
          Tells whether or not this float buffer is direct.
abstract  ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder order sample code for java.nio.FloatBuffer.order() definition code for java.nio.FloatBuffer.order() ()
          Retrieves this buffer's byte order.
abstract  FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer put sample code for java.nio.FloatBuffer.put(float) definition code for java.nio.FloatBuffer.put(float) (float f)
          Relative put method  (optional operation).
 FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer put sample code for java.nio.FloatBuffer.put(float[]) definition code for java.nio.FloatBuffer.put(float[]) (float[] src)
          Relative bulk put method  (optional operation).
 FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer put sample code for java.nio.FloatBuffer.put(float[], int, int) definition code for java.nio.FloatBuffer.put(float[], int, int) (float[] src, int offset, int length)
          Relative bulk put method  (optional operation).
 FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer put sample code for java.nio.FloatBuffer.put(java.nio.FloatBuffer) definition code for java.nio.FloatBuffer.put(java.nio.FloatBuffer) (FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  src)
          Relative bulk put method  (optional operation).
abstract  FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer put sample code for java.nio.FloatBuffer.put(int, float) definition code for java.nio.FloatBuffer.put(int, float) (int index, float f)
          Absolute put method  (optional operation).
abstract  FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer slice sample code for java.nio.FloatBuffer.slice() definition code for java.nio.FloatBuffer.slice() ()
          Creates a new float buffer whose content is a shared subsequence of this buffer's content.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.nio.FloatBuffer.toString() definition code for java.nio.FloatBuffer.toString() ()
          Returns a string summarizing the state of this buffer.
static FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer wrap sample code for java.nio.FloatBuffer.wrap(float[]) definition code for java.nio.FloatBuffer.wrap(float[]) (float[] array)
          Wraps a float array into a buffer.
static FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer wrap sample code for java.nio.FloatBuffer.wrap(float[], int, int) definition code for java.nio.FloatBuffer.wrap(float[], int, int) (float[] array, int offset, int length)
          Wraps a float array into a buffer.
 
Methods inherited from class java.nio.Buffer sample code for java.nio.Buffer definition code for java.nio.Buffer
capacity sample code for java.nio.Buffer.capacity() definition code for java.nio.Buffer.capacity() , clear sample code for java.nio.Buffer.clear() definition code for java.nio.Buffer.clear() , flip sample code for java.nio.Buffer.flip() definition code for java.nio.Buffer.flip() , hasRemaining sample code for java.nio.Buffer.hasRemaining() definition code for java.nio.Buffer.hasRemaining() , isReadOnly sample code for java.nio.Buffer.isReadOnly() definition code for java.nio.Buffer.isReadOnly() , limit sample code for java.nio.Buffer.limit() definition code for java.nio.Buffer.limit() , limit sample code for java.nio.Buffer.limit(int) definition code for java.nio.Buffer.limit(int) , mark sample code for java.nio.Buffer.mark() definition code for java.nio.Buffer.mark() , position sample code for java.nio.Buffer.position() definition code for java.nio.Buffer.position() , position sample code for java.nio.Buffer.position(int) definition code for java.nio.Buffer.position(int) , remaining sample code for java.nio.Buffer.remaining() definition code for java.nio.Buffer.remaining() , reset sample code for java.nio.Buffer.reset() definition code for java.nio.Buffer.reset() , rewind sample code for java.nio.Buffer.rewind() definition code for java.nio.Buffer.rewind()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Method Detail

allocate sample code for java.nio.FloatBuffer.allocate(int) definition code for java.nio.FloatBuffer.allocate(int)

public static FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  allocate(int capacity)
Allocates a new float buffer.

The new buffer's position will be zero, its limit will be its capacity, and its mark will be undefined. It will have a backing array sample code for java.nio.FloatBuffer.array() definition code for java.nio.FloatBuffer.array() , and its array offset sample code for java.nio.FloatBuffer.arrayOffset() definition code for java.nio.FloatBuffer.arrayOffset() will be zero.

Parameters:
capacity - The new buffer's capacity, in floats
Returns:
The new float buffer
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - If the capacity is a negative integer

wrap sample code for java.nio.FloatBuffer.wrap(float[], int, int) definition code for java.nio.FloatBuffer.wrap(float[], int, int)

public static FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  wrap(float[] array,
                               int offset,
                               int length)
Wraps a float array into a buffer.

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 sample code for java.nio.FloatBuffer.array() definition code for java.nio.FloatBuffer.array() will be the given array, and its array offset sample code for java.nio.FloatBuffer.arrayOffset() definition code for java.nio.FloatBuffer.arrayOffset() will be zero.

Parameters:
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 than array.length - offset. The new buffer's limit will be set to offset + length.
Returns:
The new float buffer
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold

wrap sample code for java.nio.FloatBuffer.wrap(float[]) definition code for java.nio.FloatBuffer.wrap(float[])

public static FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  wrap(float[] array)
Wraps a float array into a buffer.

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 sample code for java.nio.FloatBuffer.array() definition code for java.nio.FloatBuffer.array() will be the given array, and its array offset sample code for java.nio.FloatBuffer.arrayOffset() definition code for java.nio.FloatBuffer.arrayOffset() will be zero.

Parameters:
array - The array that will back this buffer
Returns:
The new float buffer

slice sample code for java.nio.FloatBuffer.slice() definition code for java.nio.FloatBuffer.slice()

public abstract FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  slice()
Creates a new float buffer whose content is a shared subsequence of this buffer's content.

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.

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.

Returns:
The new float buffer

duplicate sample code for java.nio.FloatBuffer.duplicate() definition code for java.nio.FloatBuffer.duplicate()

public abstract FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  duplicate()
Creates a new float buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. 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.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer. 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.

Returns:
The new float buffer

asReadOnlyBuffer sample code for java.nio.FloatBuffer.asReadOnlyBuffer() definition code for java.nio.FloatBuffer.asReadOnlyBuffer()

public abstract FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  asReadOnlyBuffer()
Creates a new, read-only float buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer.

If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate sample code for java.nio.FloatBuffer.duplicate() definition code for java.nio.FloatBuffer.duplicate() method.

Returns:
The new, read-only float buffer

get sample code for java.nio.FloatBuffer.get() definition code for java.nio.FloatBuffer.get()

public abstract float get()
Relative get method. Reads the float at this buffer's current position, and then increments the position.

Returns:
The float at the buffer's current position
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If the buffer's current position is not smaller than its limit

put sample code for java.nio.FloatBuffer.put(float) definition code for java.nio.FloatBuffer.put(float)

public abstract FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  put(float f)
Relative put method  (optional operation).

Writes the given float into this buffer at the current position, and then increments the position.

Parameters:
f - The float to be written
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If this buffer's current position is not smaller than its limit
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

get sample code for java.nio.FloatBuffer.get(int) definition code for java.nio.FloatBuffer.get(int)

public abstract float get(int index)
Absolute get method. Reads the float at the given index.

Parameters:
index - The index from which the float will be read
Returns:
The float at the given index
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit

put sample code for java.nio.FloatBuffer.put(int, float) definition code for java.nio.FloatBuffer.put(int, float)

public abstract FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  put(int index,
                                float f)
Absolute put method  (optional operation).

Writes the given float into this buffer at the given index.

Parameters:
index - The index at which the float will be written
f - The float value to be written
Returns:
This buffer
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

get sample code for java.nio.FloatBuffer.get(float[], int, int) definition code for java.nio.FloatBuffer.get(float[], int, int)

public FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  get(float[] dst,
                       int offset,
                       int length)
Relative bulk get method.

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 sample code for java.nio.BufferUnderflowException definition code for java.nio.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.

Parameters:
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
Returns:
This buffer
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If there are fewer than length floats remaining in this buffer
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold

get sample code for java.nio.FloatBuffer.get(float[]) definition code for java.nio.FloatBuffer.get(float[])

public FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  get(float[] dst)
Relative bulk get method.

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) 

Returns:
This buffer
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If there are fewer than length floats remaining in this buffer

put sample code for java.nio.FloatBuffer.put(java.nio.FloatBuffer) definition code for java.nio.FloatBuffer.put(java.nio.FloatBuffer)

public FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  put(FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  src)
Relative bulk put method  (optional operation).

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 sample code for java.nio.BufferOverflowException definition code for java.nio.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.

Parameters:
src - The source buffer from which floats are to be read; must not be this buffer
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there is insufficient space in this buffer for the remaining floats in the source buffer
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - If the source buffer is this buffer
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

put sample code for java.nio.FloatBuffer.put(float[], int, int) definition code for java.nio.FloatBuffer.put(float[], int, int)

public FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  put(float[] src,
                       int offset,
                       int length)
Relative bulk put method  (optional operation).

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 sample code for java.nio.BufferOverflowException definition code for java.nio.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.

Parameters:
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
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there is insufficient space in this buffer
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

put sample code for java.nio.FloatBuffer.put(float[]) definition code for java.nio.FloatBuffer.put(float[])

public final FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  put(float[] src)
Relative bulk put method  (optional operation).

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) 

Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there is insufficient space in this buffer
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

hasArray sample code for java.nio.FloatBuffer.hasArray() definition code for java.nio.FloatBuffer.hasArray()

public final boolean hasArray()
Tells whether or not this buffer is backed by an accessible float array.

If this method returns true then the array sample code for java.nio.FloatBuffer.array() definition code for java.nio.FloatBuffer.array() and arrayOffset sample code for java.nio.FloatBuffer.arrayOffset() definition code for java.nio.FloatBuffer.arrayOffset() methods may safely be invoked.

Returns:
true if, and only if, this buffer is backed by an array and is not read-only

array sample code for java.nio.FloatBuffer.array() definition code for java.nio.FloatBuffer.array()

public final float[] array()
Returns the float array that backs this buffer  (optional operation).

Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa.

Invoke the hasArray sample code for java.nio.FloatBuffer.hasArray() definition code for java.nio.FloatBuffer.hasArray() method before invoking this method in order to ensure that this buffer has an accessible backing array.

Returns:
The array that backs this buffer
Throws:
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is backed by an array but is read-only
UnsupportedOperationException sample code for java.lang.UnsupportedOperationException definition code for java.lang.UnsupportedOperationException - If this buffer is not backed by an accessible array

arrayOffset sample code for java.nio.FloatBuffer.arrayOffset() definition code for java.nio.FloatBuffer.arrayOffset()

public final int arrayOffset()
Returns the offset within this buffer's backing array of the first element of the buffer  (optional operation).

If this buffer is backed by an array then buffer position p corresponds to array index p + arrayOffset().

Invoke the hasArray sample code for java.nio.FloatBuffer.hasArray() definition code for java.nio.FloatBuffer.hasArray() method before invoking this method in order to ensure that this buffer has an accessible backing array.

Returns:
The offset within this buffer's array of the first element of the buffer
Throws:
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is backed by an array but is read-only
UnsupportedOperationException sample code for java.lang.UnsupportedOperationException definition code for java.lang.UnsupportedOperationException - If this buffer is not backed by an accessible array

compact sample code for java.nio.FloatBuffer.compact() definition code for java.nio.FloatBuffer.compact()

public abstract FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  compact()
Compacts this buffer  (optional operation).

The floats between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the float at index p = position() is copied to index zero, the float at index p + 1 is copied to index one, and so forth until the float at index limit() - 1 is copied to index n = limit() - 1 - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.

The buffer's position is set to the number of floats copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.

Returns:
This buffer
Throws:
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

isDirect sample code for java.nio.FloatBuffer.isDirect() definition code for java.nio.FloatBuffer.isDirect()

public abstract boolean isDirect()
Tells whether or not this float buffer is direct.

Returns:
true if, and only if, this buffer is direct

toString sample code for java.nio.FloatBuffer.toString() definition code for java.nio.FloatBuffer.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a string summarizing the state of this buffer.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
A summary string

hashCode sample code for java.nio.FloatBuffer.hashCode() definition code for java.nio.FloatBuffer.hashCode()

public int hashCode()
Returns the current hash code of this buffer.

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.

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
The current hash code of this buffer
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

equals sample code for java.nio.FloatBuffer.equals(java.lang.Object) definition code for java.nio.FloatBuffer.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  ob)
Tells whether or not this buffer is equal to another object.

Two float buffers are equal if, and only if,

  1. They have the same element type,

  2. They have the same number of remaining elements, and

  3. 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.

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
ob - The object to which this buffer is to be compared
Returns:
true if, and only if, this buffer is equal to the given object
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

compareTo sample code for java.nio.FloatBuffer.compareTo(java.nio.FloatBuffer) definition code for java.nio.FloatBuffer.compareTo(java.nio.FloatBuffer)

public int compareTo(FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  that)
Compares this buffer to another.

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.

Specified by:
compareTo sample code for java.lang.Comparable.compareTo(T) definition code for java.lang.Comparable.compareTo(T) in interface Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer >
Parameters:
that - the Object to be compared.
Returns:
A negative integer, zero, or a positive integer as this buffer is less than, equal to, or greater than the given buffer

order sample code for java.nio.FloatBuffer.order() definition code for java.nio.FloatBuffer.order()

public abstract ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder  order()
Retrieves this buffer's byte order.

The byte order of a float buffer created by allocation or by wrapping an existing float array is the native order sample code for java.nio.ByteOrder.nativeOrder() definition code for java.nio.ByteOrder.nativeOrder() of the underlying hardware. The byte order of a float buffer created as a view of a byte buffer is that of the byte buffer at the moment that the view is created.

Returns:
This buffer's byte order