public abstract class IntBuffer extends Buffer implements Comparable<IntBuffer>
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;ByteBuffer.asIntBuffer
to
create a int buffer based on a byte buffer.Modifier and Type | Method and Description |
---|---|
static IntBuffer |
allocate(int capacity)
Creates an int buffer based on a newly allocated int array.
|
int[] |
array()
Returns the array that backs this buffer (optional operation).
|
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()
Returns the int at the current position and increases the position by 1.
|
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.
|
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.
|
abstract IntBuffer |
put(int i)
Writes the given int to the current position and increases the position
by 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.
|
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.
|
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. |
abstract IntBuffer |
put(int index,
int i)
Write a int to the specified index of this buffer; the position is not
changed.
|
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.
|
public static IntBuffer allocate(int capacity)
capacity
- the capacity of the new buffer.IllegalArgumentException
- if capacity
is less than zero.public static IntBuffer wrap(int[] array)
Calling this method has the same effect as
wrap(array, 0, array.length)
.
array
- the int array which the new buffer will be based on.public static IntBuffer wrap(int[] array, int start, int intCount)
The new buffer's position will be start
, limit will be
start + intCount
, capacity will be the length of the array.
array
- the int array which the new buffer will be based on.start
- the start index, must not be negative and not greater than
array.length
intCount
- the length, must not be negative and not greater than
array.length - start
.IndexOutOfBoundsException
- if either start
or intCount
is invalid.public final int[] array()
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.)
public final int arrayOffset()
Buffer
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.)
arrayOffset
in class Buffer
public abstract IntBuffer asReadOnlyBuffer()
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.
public abstract IntBuffer compact()
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.
ReadOnlyBufferException
- if no changes may be made to the contents of this buffer.public int compareTo(IntBuffer otherBuffer)
compareTo
in interface Comparable<IntBuffer>
otherBuffer
- another int buffer.other
; 0 if this
equals to other
; a positive value if this is greater
than other
.ClassCastException
- if other
is not an int buffer.public abstract IntBuffer duplicate()
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 buffer's position, limit and mark are independent.
public boolean equals(Object other)
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.
equals
in class Object
other
- the object to compare with this int buffer.true
if this int buffer is equal to other
,
false
otherwise.Object.hashCode()
public abstract int get()
BufferUnderflowException
- if the position is equal or greater than limit.public IntBuffer get(int[] dst)
Calling this method has the same effect as
get(dst, 0, dst.length)
.
dst
- the destination int array.BufferUnderflowException
- if dst.length
is greater than remaining()
.public IntBuffer get(int[] dst, int dstOffset, int intCount)
dst
- the target int array.dstOffset
- the offset of the int array, must not be negative and not
greater than dst.length
.intCount
- the number of ints to read, must be no less than zero and not
greater than dst.length - dstOffset
.IndexOutOfBoundsException
- if either dstOffset
or intCount
is invalid.BufferUnderflowException
- if intCount
is greater than remaining()
.public abstract int get(int index)
index
- the index, must not be negative and less than limit.IndexOutOfBoundsException
- if index is invalid.public final boolean hasArray()
Buffer
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
.public int hashCode()
hashCode
in class Object
Object.equals(java.lang.Object)
public abstract boolean isDirect()
An int buffer is direct if it is based on a byte buffer and the byte buffer is direct.
public abstract ByteOrder order()
If this buffer is not based on a byte buffer, then always return the platform's native byte order.
public abstract IntBuffer put(int i)
i
- the int to write.BufferOverflowException
- if position is equal or greater than limit.ReadOnlyBufferException
- if no changes may be made to the contents of this buffer.public final IntBuffer put(int[] src)
Calling this method has the same effect as
put(src, 0, src.length)
.
src
- the source int array.BufferOverflowException
- if remaining()
is less than src.length
.ReadOnlyBufferException
- if no changes may be made to the contents of this buffer.public IntBuffer put(int[] src, int srcOffset, int intCount)
src
- the source int array.srcOffset
- the offset of int array, must not be negative and not greater
than src.length
.intCount
- the number of ints to write, must be no less than zero and not
greater than src.length - srcOffset
.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.public IntBuffer put(IntBuffer src)
src
int buffer to this
buffer's current position, and increases both buffers' position by the
number of ints copied.src
- the source int buffer.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.public abstract IntBuffer put(int index, int i)
index
- the index, must not be negative and less than the limit.i
- the int to write.IndexOutOfBoundsException
- if index is invalid.ReadOnlyBufferException
- if no changes may be made to the contents of this buffer.public abstract IntBuffer slice()
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 buffer's position, limit and mark are independent.