Package java.nio

Class IntBuffer

java.lang.Object
java.nio.Buffer
java.nio.IntBuffer
All Implemented Interfaces:
Comparable<IntBuffer>
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.

  • Method Summary

    Modifier and Type Method 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.
    abstract IntBuffer put​(int index, int i)
    Write a int to the specified index of this buffer; the position is not changed.
    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 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.

    Methods inherited from class java.nio.Buffer

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

    Methods inherited from class java.lang.Object

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

  • Method Details

    • allocate

      public static IntBuffer allocate​(int capacity)
      Creates an int buffer based on a newly 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 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 - 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.
      Returns:
      the created int buffer.
      Throws:
      IndexOutOfBoundsException - if either start or intCount is invalid.

    • array

      public final int[] array()
      Description copied from class: Buffer
      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.)

      Specified by:
      array in class Buffer
      Returns:
      the array

    • arrayOffset

      public final int arrayOffset()
      Description copied from class: Buffer
      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.)

      Specified by:
      arrayOffset in class Buffer
      Returns:
      the offset

    • asReadOnlyBuffer

      public abstract 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:
      a read-only 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, starting 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)
      Compares 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 an int buffer.

    • duplicate

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

    • equals

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

      Overrides:
      equals in class Object
      Parameters:
      other - the object to compare with this int buffer.
      Returns:
      true if this int buffer is equal to other, false otherwise.
      See Also:
      Object.hashCode()

    • get

      public abstract int get()
      Returns the int at the current position and increases 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[] 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 - the destination int array.
      Returns:
      this buffer.
      Throws:
      BufferUnderflowException - if dst.length is greater than remaining().

    • get

      public 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 - 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.
      Returns:
      this buffer.
      Throws:
      IndexOutOfBoundsException - if either dstOffset or intCount is invalid.
      BufferUnderflowException - if intCount is greater than remaining().

    • get

      public abstract int get​(int index)
      Returns an int at the specified index; the position is not changed.
      Parameters:
      index - the index, must not be negative and less than limit.
      Returns:
      an int at the specified index.
      Throws:
      IndexOutOfBoundsException - if index is invalid.

    • hasArray

      public final boolean hasArray()
      Description copied from class: Buffer
      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.
      Specified by:
      hasArray in class Buffer

    • hashCode

      public int hashCode()
      Calculates this buffer's hash code from the remaining chars. The 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()
      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.

      Specified by:
      isDirect in class Buffer
      Returns:
      true if this buffer is direct, false otherwise.

    • 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.

    • put

      public abstract IntBuffer put​(int i)
      Writes the given int to the current position and increases 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 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 - 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 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 - 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.
      Returns:
      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

      public 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 - 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; the position is not changed.
      Parameters:
      index - the index, must not be negative 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 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.