java.nio
Class HeapFloatBuffer

java.lang.Object
  extended byjava.nio.Buffer
      extended byjava.nio.FloatBuffer
          extended byjava.nio.HeapFloatBuffer
All Implemented Interfaces:
Comparable
Direct Known Subclasses:
HeapFloatBufferR

class HeapFloatBuffer
extends FloatBuffer

A read/write HeapFloatBuffer.


Field Summary
 
Fields inherited from class java.nio.FloatBuffer
hb, isReadOnly, offset
 
Fields inherited from class java.nio.Buffer
address
 
Constructor Summary
(package private) HeapFloatBuffer(float[] buf, int off, int len)
           
protected HeapFloatBuffer(float[] buf, int mark, int pos, int lim, int cap, int off)
           
(package private) HeapFloatBuffer(int cap, int lim)
           
 
Method Summary
 FloatBuffer asReadOnlyBuffer()
          Creates a new, read-only float buffer that shares this buffer's content.
 FloatBuffer compact()
          Compacts this buffer  (optional operation).
 FloatBuffer duplicate()
          Creates a new float buffer that shares this buffer's content.
 float get()
          Relative get method.
 FloatBuffer get(float[] dst, int offset, int length)
          Relative bulk get method.
 float get(int i)
          Absolute get method.
 boolean isDirect()
          Tells whether or not this float buffer is direct.
 boolean isReadOnly()
          Tells whether or not this buffer is read-only.
protected  int ix(int i)
           
 ByteOrder order()
          Retrieves this buffer's byte order.
 FloatBuffer put(float x)
          Relative put method  (optional operation).
 FloatBuffer put(float[] src, int offset, int length)
          Relative bulk put method  (optional operation).
 FloatBuffer put(FloatBuffer src)
          Relative bulk put method  (optional operation).
 FloatBuffer put(int i, float x)
          Absolute put method  (optional operation).
 FloatBuffer slice()
          Creates a new float buffer whose content is a shared subsequence of this buffer's content.
 
Methods inherited from class java.nio.FloatBuffer
allocate, array, arrayOffset, compareTo, equals, get, hasArray, hashCode, put, toString, wrap, wrap
 
Methods inherited from class java.nio.Buffer
capacity, checkBounds, checkIndex, checkIndex, clear, flip, hasRemaining, limit, limit, mark, markValue, nextGetIndex, nextGetIndex, nextPutIndex, nextPutIndex, position, position, remaining, reset, rewind
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HeapFloatBuffer

HeapFloatBuffer(int cap,
                int lim)

HeapFloatBuffer

HeapFloatBuffer(float[] buf,
                int off,
                int len)

HeapFloatBuffer

protected HeapFloatBuffer(float[] buf,
                          int mark,
                          int pos,
                          int lim,
                          int cap,
                          int off)
Method Detail

slice

public FloatBuffer slice()
Description copied from class: FloatBuffer
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.

Specified by:
slice in class FloatBuffer
Returns:
The new float buffer

duplicate

public FloatBuffer duplicate()
Description copied from class: FloatBuffer
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.

Specified by:
duplicate in class FloatBuffer
Returns:
The new float buffer

asReadOnlyBuffer

public FloatBuffer asReadOnlyBuffer()
Description copied from class: FloatBuffer
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 method.

Specified by:
asReadOnlyBuffer in class FloatBuffer
Returns:
The new, read-only float buffer

ix

protected int ix(int i)

get

public float get()
Description copied from class: FloatBuffer
Relative get method. Reads the float at this buffer's current position, and then increments the position.

Specified by:
get in class FloatBuffer
Returns:
The float at the buffer's current position

get

public float get(int i)
Description copied from class: FloatBuffer
Absolute get method. Reads the float at the given index.

Specified by:
get in class FloatBuffer
Parameters:
i - The index from which the float will be read
Returns:
The float at the given index

get

public FloatBuffer get(float[] dst,
                       int offset,
                       int length)
Description copied from class: FloatBuffer
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 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.

Overrides:
get in class FloatBuffer
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

isDirect

public boolean isDirect()
Description copied from class: FloatBuffer
Tells whether or not this float buffer is direct.

Specified by:
isDirect in class FloatBuffer
Returns:
true if, and only if, this buffer is direct

isReadOnly

public boolean isReadOnly()
Description copied from class: Buffer
Tells whether or not this buffer is read-only.

Specified by:
isReadOnly in class Buffer
Returns:
true if, and only if, this buffer is read-only

put

public FloatBuffer put(float x)
Description copied from class: FloatBuffer
Relative put method  (optional operation).

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

Specified by:
put in class FloatBuffer
Parameters:
x - The float to be written
Returns:
This buffer

put

public FloatBuffer put(int i,
                       float x)
Description copied from class: FloatBuffer
Absolute put method  (optional operation).

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

Specified by:
put in class FloatBuffer
Parameters:
i - The index at which the float will be written
x - The float value to be written
Returns:
This buffer

put

public FloatBuffer put(float[] src,
                       int offset,
                       int length)
Description copied from class: FloatBuffer
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 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.

Overrides:
put in class FloatBuffer
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

put

public FloatBuffer put(FloatBuffer src)
Description copied from class: FloatBuffer
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 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.

Overrides:
put in class FloatBuffer
Parameters:
src - The source buffer from which floats are to be read; must not be this buffer
Returns:
This buffer

compact

public FloatBuffer compact()
Description copied from class: FloatBuffer
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.

Specified by:
compact in class FloatBuffer
Returns:
This buffer

order

public ByteOrder order()
Description copied from class: FloatBuffer
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 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.

Specified by:
order in class FloatBuffer
Returns:
This buffer's byte order