java.nio
Class FloatBuffer

java.lang.Object
  java.nio.Buffer
      java.nio.FloatBuffer

All Implemented Interfaces:

Comparable<FloatBuffer>

Direct Known Subclasses:

FloatArrayBuffer, FloatToByteBufferAdapter

public abstract class FloatBuffer
extends Buffer
implements Comparable<FloatBuffer>

A buffer of floats.

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.

Field Summary

Fields inherited from class java.nio.Buffer

_elementSizeShift, capacity, limit, mark, position, UNSET_MARK

Constructor Summary

FloatBuffer(int capacity)
Constructs a FloatBuffer with given capacity.

Method Summary

(package private) Object	_array() Returns the array associated with this buffer, or null if none exists.
(package private) int	_arrayOffset() Returns the offset into the backing array, if one exists, otherwise 0.
static FloatBuffer	allocate(int capacity) Creates a float buffer based on a new allocated float array.
float[]	array() Returns the float array which this buffer is based on, if there's one.
int	arrayOffset() Returns the offset of the float array which this buffer is based on, if there's one.
abstract FloatBuffer	asReadOnlyBuffer() Returns a readonly buffer that shares content with this buffer.
abstract FloatBuffer	compact() Compacts this float buffer.
int	compareTo(FloatBuffer otherBuffer) Compare the remaining floats of this buffer to another float buffer's remaining floats.
abstract FloatBuffer	duplicate() Returns a duplicated buffer that shares content with this buffer.
boolean	equals(Object other) Tests whether this float buffer equals to another object.
abstract float	get() Returns the float at the current position and increase the position by 1.
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.
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 float	get(int index) Returns a float at the specified index, and the position is not changed.
boolean	hasArray() Returns whether this buffer is based on a float array and is read/write.
int	hashCode() Hash code is calculated from the remaining floats.
abstract boolean	isDirect() Returns true if this buffer is direct.
abstract ByteOrder	order() Returns the byte order used by this buffer when converting floats from/to bytes.
(package private) abstract float[]	protectedArray() Child class implements this method to realize array().
(package private) abstract int	protectedArrayOffset() Child class implements this method to realize arrayOffset().
(package private) abstract boolean	protectedHasArray() Child class implements this method to realize hasArray().
abstract FloatBuffer	put(float f) Writes the given float to the current position and increase the position by 1.
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.
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.
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 FloatBuffer	put(int index, float f) Write a float to the specified index of this buffer and the position is not changed.
abstract FloatBuffer	slice() Returns a sliced buffer that shares content with this buffer.
String	toString() Returns a string represents the state of this float buffer.
static FloatBuffer	wrap(float[] array) Creates a new float buffer by wrapping the given float array.
static FloatBuffer	wrap(float[] array, int start, int len) Creates new a float buffer by wrapping the given float array.

Methods inherited from class java.nio.Buffer

capacity, clear, flip, hasRemaining, isReadOnly, limit, limit, mark, position, position, remaining, reset, rewind

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FloatBuffer

FloatBuffer(int capacity)

Constructs a FloatBuffer with given capacity.

Parameters:

capacity - The capacity of the buffer

Method Detail

allocate

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

Returns:

The created float buffer

Throws:

IllegalArgumentException - If capacity is less than zero

wrap

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

Returns:

The created float buffer

wrap

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

Returns:

The created float buffer

Throws:

IndexOutOfBoundsException - If either start or len is invalid

array

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

Throws:

ReadOnlyBufferException - If this buffer is based on an array, but it is readonly

UnsupportedOperationException - If this buffer is not based on an array

arrayOffset

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

Throws:

ReadOnlyBufferException - If this buffer is based on an array, but it is readonly

UnsupportedOperationException - If this buffer is not based on an array

_array

Object _array()

Description copied from class: Buffer

Returns the array associated with this buffer, or null if none exists. Each typed subclass (ByteBuffer, CharBuffer, etc.) overrides this method to call its array() method with appropriate checks.

Overrides:

_array in class Buffer

Returns:

a primitive array or null

_arrayOffset

int _arrayOffset()

Description copied from class: Buffer

Returns the offset into the backing array, if one exists, otherwise 0. Each typed subclass (ByteBuffer, CharBuffer, etc.) overrides this method to call its arrayOffset() method with appropriate checks.

Overrides:

_arrayOffset in class Buffer

Returns:

the array offset, or 0

asReadOnlyBuffer

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.

compact

public abstract FloatBuffer compact()

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.

Returns:

This buffer

Throws:

ReadOnlyBufferException - If no changes may be made to the contents of this buffer

compareTo

public int compareTo(FloatBuffer otherBuffer)

Compare the remaining floats of this buffer to another float buffer's remaining floats.

Specified by:

compareTo in interface Comparable<FloatBuffer>

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

Throws:

ClassCastException - If other is not a float buffer

duplicate

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.

equals

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. Position, limit, capacity and mark are not considered.

Overrides:

equals in class Object

Parameters:

other - the object to be compared against

Returns:

Whether this float buffer equals to another object.

See Also:

Object.hashCode()

get

public abstract float get()

Returns the float at the current position and increase the position by 1.

Returns:

The float at the current position.

Throws:

BufferUnderflowException - If the position is equal or greater than limit

get

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.

Calling this method has the same effect as get(dest, 0, dest.length).

Parameters:

dest - The destination float array

Returns:

This buffer

Throws:

BufferUnderflowException - if dest.length is greater than remaining()

get

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.

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 floats to read, must be no less than zero and no greater than dest.length - off

Returns:

This buffer

Throws:

IndexOutOfBoundsException - If either off or len is invalid

BufferUnderflowException - If len is greater than remaining()

get

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.

Throws:

IndexOutOfBoundsException - If index is invalid

hasArray

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.

hashCode

public int hashCode()

Hash code is calculated from the remaining floats.

Position, limit, capacity and mark don't affect the hash code.

Overrides:

hashCode in class Object

Returns:

The hash code calculated from the remaining floats.

See Also:

Object.equals(java.lang.Object)

isDirect

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.

order

public abstract ByteOrder order()

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.

Returns:

The byte order used by this buffer when converting floats from/to bytes.

protectedArray

abstract float[] protectedArray()

Child class implements this method to realize array().

Returns:

see array()

protectedArrayOffset

abstract int protectedArrayOffset()

Child class implements this method to realize arrayOffset().

Returns:

see arrayOffset()

protectedHasArray

abstract boolean protectedHasArray()

Child class implements this method to realize hasArray().

Returns:

see hasArray()

put

public abstract FloatBuffer put(float f)

Writes the given float to the current position and increase the position by 1.

Parameters:

f - The float to write

Returns:

This buffer

Throws:

BufferOverflowException - If position is equal or greater than limit

ReadOnlyBufferException - If no changes may be made to the contents of this buffer

put

public final 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.

Calling this method has the same effect as put(src, 0, src.length).

Parameters:

src - The source float array

Returns:

This buffer

Throws:

BufferOverflowException - If remaining() is less than src.length

ReadOnlyBufferException - If no changes may be made to the contents of this buffer

put

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.

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 floats to write, must be no less than zero and no greater than src.length - off

Returns:

This buffer

Throws:

BufferOverflowException - If remaining() is less than len

IndexOutOfBoundsException - If either off or len is invalid

ReadOnlyBufferException - If no changes may be made to the contents of this buffer

put

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.

Parameters:

src - The source float buffer

Returns:

This buffer

Throws:

BufferOverflowException - If src.remaining() is greater than this buffer's remaining()

IllegalArgumentException - If src is this buffer

ReadOnlyBufferException - If no changes may be made to the contents of this buffer

put

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

Returns:

This buffer

Throws:

IndexOutOfBoundsException - If index is invalid

ReadOnlyBufferException - If no changes may be made to the contents of this buffer

slice

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.

toString

public String toString()

Returns a string represents the state of this float buffer.

Overrides:

toString in class Object

Returns:

A string represents the state of this float buffer.