java.nio

Class IntBuffer

Implemented Interfaces:
Comparable<T>

public abstract class IntBuffer
extends Buffer
implements Comparable<T>

Since:
1.4

Method Summary

static IntBuffer
allocate(int capacity)
Allocates a new IntBuffer object with a given capacity.
int[]
array()
Returns the int array that backs this buffer.
int
arrayOffset()
Returns the offset within this buffer's backing array of the first element.
abstract IntBuffer
asReadOnlyBuffer()
Creates a new read-only IntBuffer that shares this buffer's content.
abstract IntBuffer
compact()
Compacts this buffer.
int
compareTo(IntBuffer other)
Compares two IntBuffer objects.
abstract IntBuffer
duplicate()
Creates a new IntBuffer that shares this buffer's content.
boolean
equals(Object obj)
Checks if this buffer is equal to obj.
abstract int
get()
Reads the int at this buffer's current position, and then increments the position.
abstract int
get(int index)
Absolute get method.
IntBuffer
get(int[] dst)
This method transfers ints from this buffer into the given destination array.
IntBuffer
get(int[] dst, int offset, int length)
This method transfers ints from this buffer into the given destination array.
boolean
hasArray()
Tells whether ot not this buffer is backed by an accessible int array.
int
hashCode()
Calculates a hash code for this buffer.
abstract boolean
isDirect()
Tells wether or not this buffer is direct.
abstract ByteOrder
order()
Returns the byte order of this buffer.
abstract IntBuffer
put(int b)
Writes the int at this buffer's current position, and then increments the position.
abstract IntBuffer
put(int index, int b)
Absolute put method.
IntBuffer
put(int[] src)
Writes the content of the the int array src into the buffer.
IntBuffer
put(int[] src, int offset, int length)
Writes the content of the the int array src into the buffer.
IntBuffer
put(IntBuffer src)
Writes the content of the the IntBUFFER src into the buffer.
abstract IntBuffer
slice()
Creates a new IntBuffer whose content is a shared subsequence of this buffer's content.
static IntBuffer
wrap(int[] array)
Wraps a int array into a IntBuffer object.
static IntBuffer
wrap(int[] array, int offset, int length)
Wraps a int array into a IntBuffer object.

Methods inherited from class java.nio.Buffer

array, arrayOffset, capacity, clear, flip, hasArray, hasRemaining, isDirect, isReadOnly, limit, limit, mark, position, position, remaining, reset, rewind

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

allocate

public static IntBuffer allocate(int capacity)
Allocates a new IntBuffer object with a given capacity.

array

public final int[] array()
Returns the int array that backs this buffer.
Overrides:
array in interface Buffer
Throws:
ReadOnlyBufferException - If this buffer is read-only.
UnsupportedOperationException - If this buffer is not backed by an accessible array.

arrayOffset

public final int arrayOffset()
Returns the offset within this buffer's backing array of the first element.
Overrides:
arrayOffset in interface Buffer
Throws:
ReadOnlyBufferException - If this buffer is read-only.
UnsupportedOperationException - If this buffer is not backed by an accessible array.

asReadOnlyBuffer

public abstract IntBuffer asReadOnlyBuffer()
Creates a new read-only IntBuffer that shares this buffer's content.

compact

public abstract IntBuffer compact()
Compacts this buffer.
Throws:
ReadOnlyBufferException - If this buffer is read-only.

compareTo

public int compareTo(IntBuffer other)
Compares two IntBuffer objects.
Throws:
ClassCastException - If obj is not an object derived from IntBuffer.

duplicate

public abstract IntBuffer duplicate()
Creates a new IntBuffer that shares this buffer's content.

equals

public boolean equals(Object obj)
Checks if this buffer is equal to obj.
Overrides:
equals in interface Object

get

public abstract int get()
Reads the int at this buffer's current position, and then increments the position.
Throws:
BufferUnderflowException - If there are no remaining ints in this buffer.

get

public abstract int get(int index)
Absolute get method.
Throws:
IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit.

get

public IntBuffer get(int[] dst)
This method transfers ints from this buffer into the given destination array.
Parameters:
dst - The byte array to write into.
Throws:
BufferUnderflowException - If there are fewer than dst.length ints remaining in this buffer.

get

public IntBuffer get(int[] dst,
                     int offset,
                     int length)
This method transfers ints from this buffer into the given destination array. Before the transfer, it checks if there are fewer than length ints remaining in this buffer.
Parameters:
dst - The destination array
offset - The offset within the array of the first int to be written; must be non-negative and no larger than dst.length.
length - The maximum number of bytes to be written to the given array; must be non-negative and no larger than dst.length - offset.
Throws:
BufferUnderflowException - If there are fewer than length ints remaining in this buffer.
IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold.

hasArray

public final boolean hasArray()
Tells whether ot not this buffer is backed by an accessible int array.
Overrides:
hasArray in interface Buffer

hashCode

public int hashCode()
Calculates a hash code for this buffer. This is done with int arithmetic, where ** represents exponentiation, by this formula:
s[position()] + 31 + (s[position()+1] + 30)*31**1 + ... + (s[limit()-1]+30)*31**(limit()-1). Where s is the buffer data. Note that the hashcode is dependent on buffer content, and therefore is not useful if the buffer content may change.
Overrides:
hashCode in interface Object
Returns:
the hash code

isDirect

public abstract boolean isDirect()
Tells wether or not this buffer is direct.
Overrides:
isDirect in interface Buffer

order

public abstract ByteOrder order()
Returns the byte order of this buffer.

put

public abstract IntBuffer put(int b)
Writes the int at this buffer's current position, and then increments the position.
Throws:
BufferOverflowException - If there no remaining ints in this buffer.
ReadOnlyBufferException - If this buffer is read-only.

put

public abstract IntBuffer put(int index,
                              int b)
Absolute put method.
Throws:
IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit.
ReadOnlyBufferException - If this buffer is read-only.

put

public final IntBuffer put(int[] src)
Writes the content of the the int array src into the buffer.
Parameters:
src - The array to copy into the buffer.
Throws:
BufferOverflowException - If there is insufficient space in this buffer for the remaining ints in the source array.
ReadOnlyBufferException - If this buffer is read-only.

put

public IntBuffer put(int[] src,
                     int offset,
                     int length)
Writes the content of the the int array src into the buffer. Before the transfer, it checks if there is fewer than length space remaining in this buffer.
Parameters:
src - The array to copy into the buffer.
offset - The offset within the array of the first byte to be read; must be non-negative and no larger than src.length.
length - The number of bytes to be read from the given array; must be non-negative and no larger than src.length - offset.
Throws:
BufferOverflowException - If there is insufficient space in this buffer for the remaining ints in the source array.
IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold
ReadOnlyBufferException - If this buffer is read-only.

put

public IntBuffer put(IntBuffer src)
Writes the content of the the IntBUFFER src into the buffer. Before the transfer, it checks if there is fewer than src.remaining() space remaining in this buffer.
Parameters:
src - The source data.
Throws:
BufferOverflowException - If there is insufficient space in this buffer for the remaining ints in the source buffer.
IllegalArgumentException - If the source buffer is this buffer.
ReadOnlyBufferException - If this buffer is read-only.

slice

public abstract IntBuffer slice()
Creates a new IntBuffer whose content is a shared subsequence of this buffer's content.

wrap

public static final IntBuffer wrap(int[] array)
Wraps a int array into a IntBuffer object.

wrap

public static final IntBuffer wrap(int[] array,
                                   int offset,
                                   int length)
Wraps a int array into a IntBuffer object.
Throws:
IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold

IntBuffer.java -- Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.