Skip to content

Most visited

Recently visited

navigation
Added in API level 1

IntBuffer

public abstract class IntBuffer
extends Buffer implements Comparable<IntBuffer>

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


A buffer of ints.

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

Summary

Public methods

static IntBuffer allocate(int capacity)

Creates an int buffer based on a newly allocated int array.

final int[] array()

Returns the array that backs this buffer (optional operation).

final int arrayOffset()

Returns the offset into the array returned by array of the first element of the buffer (optional operation).

abstract IntBuffer asReadOnlyBuffer()

Returns a read-only buffer that shares its content with this buffer.

abstract IntBuffer compact()

Compacts this int buffer.

int compareTo(IntBuffer otherBuffer)

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

abstract IntBuffer duplicate()

Returns a duplicated buffer that shares its content with this buffer.

boolean equals(Object other)

Checks whether this int buffer is equal to another object.

abstract int get(int index)

Returns an int at the specified index; the position is not changed.

IntBuffer get(int[] dst)

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

IntBuffer get(int[] dst, int dstOffset, int intCount)

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

abstract int get()

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

final boolean hasArray()

Returns true if array and arrayOffset won't throw.

int hashCode()

Calculates this buffer's hash code from the remaining chars.

abstract boolean isDirect()

Indicates whether this buffer is direct.

abstract ByteOrder order()

Returns the byte order used by this buffer when converting ints from/to bytes.

IntBuffer put(IntBuffer src)

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

IntBuffer put(int[] src, int srcOffset, int intCount)

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

abstract IntBuffer put(int index, int i)

Write a int to the specified index of this buffer; the position is not changed.

final IntBuffer put(int[] src)

Writes ints from the given int array to the current position and increases the position by the number of ints written.

abstract IntBuffer put(int i)

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

abstract IntBuffer slice()

Returns a sliced buffer that shares its content with this 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 intCount)

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

Inherited methods

From class java.nio.Buffer
From class java.lang.Object
From interface java.lang.Comparable

Public methods

allocate

Added in API level 1
IntBuffer allocate (int capacity)

Creates an int buffer based on a newly allocated int array.

Parameters
capacity int: the capacity of the new buffer.
Returns
IntBuffer the created int buffer.
Throws
IllegalArgumentException if capacity is less than zero.

array

Added in API level 1
int[] array ()

Returns the array that backs this buffer (optional operation). The returned value is the actual array, not a copy, so modifications to the array write through to the buffer.

Subclasses should override this method with a covariant return type to provide the exact type of the array.

Use hasArray to ensure this method won't throw. (A separate call to isReadOnly is not necessary.)

Returns
int[] the array

arrayOffset

Added in API level 1
int arrayOffset ()

Returns the offset into the array returned by array of the first element of the buffer (optional operation). The backing array (if there is one) is not necessarily the same size as the buffer, and position 0 in the buffer is not necessarily the 0th element in the array. Use buffer.array()[offset + buffer.arrayOffset() to access element offset in buffer.

Use hasArray to ensure this method won't throw. (A separate call to isReadOnly is not necessary.)

Returns
int the offset

asReadOnlyBuffer

Added in API level 1
IntBuffer asReadOnlyBuffer ()

Returns a read-only buffer that shares its content with this buffer.

The returned buffer is guaranteed to be a new instance, even this buffer is read-only itself. The new buffer's position, limit, capacity and mark are the same as this buffer's.

The new buffer shares its 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
IntBuffer a read-only version of this buffer.

compact

Added in API level 1
IntBuffer compact ()

Compacts this int buffer.

The remaining ints will be moved to the head of the buffer, starting from position zero. Then the position is set to remaining(); the limit is set to capacity; the mark is cleared.

Returns
IntBuffer this buffer.
Throws
ReadOnlyBufferException if no changes may be made to the contents of this buffer.

compareTo

Added in API level 1
int compareTo (IntBuffer otherBuffer)

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

Parameters
otherBuffer IntBuffer: another int buffer.
Returns
int 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 an int buffer.

duplicate

Added in API level 1
IntBuffer duplicate ()

Returns a duplicated buffer that shares its content with this buffer.

The duplicated buffer's position, limit, capacity and mark are the same as this buffer. The duplicated buffer's read-only property and byte order are the same as this buffer's.

The new buffer shares its content with this buffer, which means either buffer's change of content will be visible to the other. The two buffers' position, limit and mark are independent.

Returns
IntBuffer

equals

Added in API level 1
boolean equals (Object other)

Checks whether this int buffer is equal to another object.

If other is not a int buffer then false is returned. Two int buffers are equal if and only if their remaining ints are exactly the same. Position, limit, capacity and mark are not considered.

Parameters
other Object: the object to compare with this int buffer.
Returns
boolean true if this int buffer is equal to other, false otherwise.

get

Added in API level 1
int get (int index)

Returns an int at the specified index; the position is not changed.

Parameters
index int: the index, must not be negative and less than limit.
Returns
int an int at the specified index.
Throws
IndexOutOfBoundsException if index is invalid.

get

Added in API level 1
IntBuffer get (int[] dst)

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

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

Parameters
dst int: the destination int array.
Returns
IntBuffer this buffer.
Throws
BufferUnderflowException if dst.length is greater than remaining().

get

Added in API level 1
IntBuffer get (int[] dst, 
                int dstOffset, 
                int intCount)

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

Parameters
dst int: the target int array.
dstOffset int: the offset of the int array, must not be negative and not greater than dst.length.
intCount int: the number of ints to read, must be no less than zero and not greater than dst.length - dstOffset.
Returns
IntBuffer this buffer.
Throws
IndexOutOfBoundsException if either dstOffset or intCount is invalid.
BufferUnderflowException if intCount is greater than remaining().

get

Added in API level 1
int get ()

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

Returns
int the int at the current position.
Throws
BufferUnderflowException if the position is equal or greater than limit.

hasArray

Added in API level 1
boolean hasArray ()

Returns true if array and arrayOffset won't throw. This method does not return true for buffers not backed by arrays because the other methods would throw UnsupportedOperationException, nor does it return true for buffers backed by read-only arrays, because the other methods would throw ReadOnlyBufferException.

Returns
boolean

hashCode

Added in API level 1
int hashCode ()

Calculates this buffer's hash code from the remaining chars. The position, limit, capacity and mark don't affect the hash code.

Returns
int the hash code calculated from the remaining ints.

isDirect

Added in API level 1
boolean isDirect ()

Indicates whether this buffer is direct. A direct buffer will try its best to take advantage of native memory APIs and it may not stay in the Java heap, so it is not affected by garbage collection.

An int buffer is direct if it is based on a byte buffer and the byte buffer is direct.

Returns
boolean true if this buffer is direct, false otherwise.

order

Added in API level 1
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
ByteOrder the byte order used by this buffer when converting ints from/to bytes.

put

Added in API level 1
IntBuffer put (IntBuffer src)

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

Parameters
src IntBuffer: the source int buffer.
Returns
IntBuffer 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

Added in API level 1
IntBuffer put (int[] src, 
                int srcOffset, 
                int intCount)

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

Parameters
src int: the source int array.
srcOffset int: the offset of int array, must not be negative and not greater than src.length.
intCount int: the number of ints to write, must be no less than zero and not greater than src.length - srcOffset.
Returns
IntBuffer this buffer.
Throws
BufferOverflowException if remaining() is less than intCount.
IndexOutOfBoundsException if either srcOffset or intCount is invalid.
ReadOnlyBufferException if no changes may be made to the contents of this buffer.

put

Added in API level 1
IntBuffer put (int index, 
                int i)

Write a int to the specified index of this buffer; the position is not changed.

Parameters
index int: the index, must not be negative and less than the limit.
i int: the int to write.
Returns
IntBuffer this buffer.
Throws
IndexOutOfBoundsException if index is invalid.
ReadOnlyBufferException if no changes may be made to the contents of this buffer.

put

Added in API level 1
IntBuffer put (int[] src)

Writes ints from the given int array to the current position and increases the position by the number of ints written.

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

Parameters
src int: the source int array.
Returns
IntBuffer 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

Added in API level 1
IntBuffer put (int i)

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

Parameters
i int: the int to write.
Returns
IntBuffer 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.

slice

Added in API level 1
IntBuffer slice ()

Returns a sliced buffer that shares its 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 cleared. The new buffer's read-only property and byte order are same as this buffer's.

The new buffer shares its content with this buffer, which means either buffer's change of content will be visible to the other. The two buffers' position, limit and mark are independent.

Returns
IntBuffer

wrap

Added in API level 1
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 int: the int array which the new buffer will be based on.
Returns
IntBuffer the created int buffer.

wrap

Added in API level 1
IntBuffer wrap (int[] array, 
                int start, 
                int intCount)

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

The new buffer's position will be start, limit will be start + intCount, capacity will be the length of the array.

Parameters
array int: the int array which the new buffer will be based on.
start int: the start index, must not be negative and not greater than array.length
intCount int: the length, must not be negative and not greater than array.length - start.
Returns
IntBuffer the created int buffer.
Throws
IndexOutOfBoundsException if either start or intCount is invalid.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.