java.nio
Class IntBuffer

java.lang.Object
  java.nio.Buffer
      java.nio.IntBuffer

All Implemented Interfaces:

Comparable<IntBuffer>

Direct Known Subclasses:

IntArrayBuffer, IntToByteBufferAdapter

public abstract class IntBuffer
extends Buffer
implements Comparable<IntBuffer>

A buffer of ints.

A int buffer can be created in either of the following ways:

• Allocate a new int array and create a buffer based on it;
• Wrap an existing int array to create a new buffer;
• Use ByteBuffer.asIntBuffer to create a int buffer based on a byte buffer.

Field Summary

Fields inherited from class java.nio.Buffer

_elementSizeShift, capacity, limit, mark, position, UNSET_MARK

Constructor Summary

IntBuffer(int capacity)
Constructs a IntBuffer 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 IntBuffer	allocate(int capacity) Creates a int buffer based on a new allocated int array.
int[]	array() Returns the int array which this buffer is based on, if there's one.
int	arrayOffset() Returns the offset of the int array which this buffer is based on, if there's one.
abstract IntBuffer	asReadOnlyBuffer() Returns a readonly buffer that shares content with this buffer.
abstract IntBuffer	compact() Compacts this int buffer.
int	compareTo(IntBuffer otherBuffer) Compare the remaining ints of this buffer to another int buffer's remaining ints.
abstract IntBuffer	duplicate() Returns a duplicated buffer that shares content with this buffer.
boolean	equals(Object other) Tests whether this int buffer equals to another object.
abstract int	get() Returns the int at the current position and increase the position by 1.
abstract int	get(int index) Returns a int at the specified index, and the position is not changed.
IntBuffer	get(int[] dest) Reads ints from the current position into the specified int array and increase the position by the number of ints read.
IntBuffer	get(int[] dest, int off, int len) Reads ints from the current position into the specified int array, starting from the specified offset, and increase the position by the number of ints read.
boolean	hasArray() Returns whether this buffer is based on a int array and is read/write.
int	hashCode() Hash code is calculated from the remaining ints.
abstract boolean	isDirect() Returns true if this buffer is direct.
abstract ByteOrder	order() Returns the byte order used by this buffer when converting ints from/to bytes.
(package private) abstract int[]	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 IntBuffer	put(int i) Writes the given int to the current position and increase the position by 1.
IntBuffer	put(int[] src) Writes ints in the given int array to the current position and increase the position by the number of ints written.
IntBuffer	put(int[] src, int off, int len) Writes ints in the given int array, starting from the specified offset, to the current position and increase the position by the number of ints written.
IntBuffer	put(IntBuffer src) Writes all the remaining ints of the src int buffer to this buffer's current position, and increase both buffers' position by the number of ints copied.
abstract IntBuffer	put(int index, int i) Write a int to the specified index of this buffer and the position is not changed.
abstract IntBuffer	slice() Returns a sliced buffer that shares content with this buffer.
String	toString() Returns a string represents the state of this int buffer.
static IntBuffer	wrap(int[] array) Creates a new int buffer by wrapping the given int array.
static IntBuffer	wrap(int[] array, int start, int len) Creates new a int buffer by wrapping the given int 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

IntBuffer

IntBuffer(int capacity)

Constructs a IntBuffer with given capacity.

Parameters:

capacity - The capacity of the buffer

Method Detail

allocate

public static IntBuffer allocate(int capacity)

Creates a int buffer based on a new allocated int array.

Parameters:

capacity - The capacity of the new buffer

Returns:

The created int buffer

Throws:

IllegalArgumentException - If capacity is less than zero

wrap

public static IntBuffer wrap(int[] array)

Creates a new int buffer by wrapping the given int array.

Calling this method has the same effect as wrap(array, 0, array.length).

Parameters:

array - The int array which the new buffer will be based on

Returns:

The created int buffer

wrap

public static IntBuffer wrap(int[] array,
                             int start,
                             int len)

Creates new a int buffer by wrapping the given int 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 int 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 int buffer

Throws:

IndexOutOfBoundsException - If either start or len is invalid

array

public final int[] array()

Returns the int array which this buffer is based on, if there's one.

Returns:

The int 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 int 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 int 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 IntBuffer 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 IntBuffer compact()

Compacts this int buffer.

The remaining ints 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(IntBuffer otherBuffer)

Compare the remaining ints of this buffer to another int buffer's remaining ints.

Specified by:

compareTo in interface Comparable<IntBuffer>

Parameters:

otherBuffer - Another int 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 int buffer

duplicate

public abstract IntBuffer 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 int buffer equals to another object.

If other is not a int buffer, then false is returned.

Two int buffers are equals if, and only if, their remaining ints 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 int buffer equals to another object.

See Also:

Object.hashCode()

get

public abstract int get()

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

Returns:

The int at the current position.

Throws:

BufferUnderflowException - If the position is equal or greater than limit

get

public IntBuffer get(int[] dest)

Reads ints from the current position into the specified int array and increase the position by the number of ints read.

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

Parameters:

dest - The destination int array

Returns:

This buffer

Throws:

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

get

public IntBuffer get(int[] dest,
                     int off,
                     int len)

Reads ints from the current position into the specified int array, starting from the specified offset, and increase the position by the number of ints read.

Parameters:

dest - The target int array

off - The offset of the int array, must be no less than zero and no greater than dest.length

len - The number of ints 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 int get(int index)

Returns a int 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 int at the specified index.

Throws:

IndexOutOfBoundsException - If index is invalid

hasArray

public final boolean hasArray()

Returns whether this buffer is based on a int array and is read/write.

If this buffer is readonly, then false is returned.

Returns:

Whether this buffer is based on a int array and is read/write.

hashCode

public int hashCode()

Hash code is calculated from the remaining ints.

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

Overrides:

hashCode in class Object

Returns:

The hash code calculated from the remaining ints.

See Also:

Object.equals(java.lang.Object)

isDirect

public abstract boolean isDirect()

Returns true if this buffer is direct.

A int 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 ints 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 ints from/to bytes.

protectedArray

abstract int[] 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 IntBuffer put(int i)

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

Parameters:

i - The int 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 IntBuffer put(int[] src)

Writes ints in the given int array to the current position and increase the position by the number of ints written.

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

Parameters:

src - The source int 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 IntBuffer put(int[] src,
                     int off,
                     int len)

Writes ints in the given int array, starting from the specified offset, to the current position and increase the position by the number of ints written.

Parameters:

src - The source int array

off - The offset of int array, must be no less than zero and no greater than src.length

len - The number of ints 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 IntBuffer put(IntBuffer src)

Writes all the remaining ints of the src int buffer to this buffer's current position, and increase both buffers' position by the number of ints copied.

Parameters:

src - The source int 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 IntBuffer put(int index,
                              int i)

Write a int 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

i - The int 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 IntBuffer 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 int buffer.

Overrides:

toString in class Object

Returns:

A string represents the state of this int buffer.