java.nio
Class HeapIntBuffer

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

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

HeapIntBufferR

class HeapIntBuffer

extends IntBuffer

A read/write HeapIntBuffer.

Field Summary

Fields inherited from class java.nio.IntBuffer

hb, isReadOnly, offset

Fields inherited from class java.nio.Buffer

address

Constructor Summary

(package private)	HeapIntBuffer(int[] buf, int off, int len)
protected	HeapIntBuffer(int[] buf, int mark, int pos, int lim, int cap, int off)
(package private)	HeapIntBuffer(int cap, int lim)

Method Summary

IntBuffer	asReadOnlyBuffer() Creates a new, read-only int buffer that shares this buffer's content.
IntBuffer	compact() Compacts this buffer (optional operation).
IntBuffer	duplicate() Creates a new int buffer that shares this buffer's content.
int	get() Relative get method.
int	get(int i) Absolute get method.
IntBuffer	get(int[] dst, int offset, int length) Relative bulk get method.
boolean	isDirect() Tells whether or not this int buffer is direct.
boolean	isReadOnly() Tells whether or not this buffer is read-only.
protected int	ix(int i)
ByteOrder	order() Retrieves this buffer's byte order.
IntBuffer	put(int x) Relative put method (optional operation).
IntBuffer	put(int[] src, int offset, int length) Relative bulk put method (optional operation).
IntBuffer	put(IntBuffer src) Relative bulk put method (optional operation).
IntBuffer	put(int i, int x) Absolute put method (optional operation).
IntBuffer	slice() Creates a new int buffer whose content is a shared subsequence of this buffer's content.

Methods inherited from class java.nio.IntBuffer

allocate, array, arrayOffset, compareTo, equals, get, hasArray, hashCode, put, toString, wrap, wrap

Methods inherited from class java.nio.Buffer

capacity, checkBounds, checkIndex, checkIndex, clear, flip, hasRemaining, limit, limit, mark, markValue, nextGetIndex, nextGetIndex, nextPutIndex, nextPutIndex, position, position, remaining, reset, rewind

Methods inherited from class java.lang.Object

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

Constructor Detail

HeapIntBuffer

HeapIntBuffer(int cap,
              int lim)

HeapIntBuffer

HeapIntBuffer(int[] buf,
              int off,
              int len)

HeapIntBuffer

protected HeapIntBuffer(int[] buf,
                        int mark,
                        int pos,
                        int lim,
                        int cap,
                        int off)

Method Detail

slice

public IntBuffer slice()

Description copied from class: IntBuffer

Creates a new int buffer whose content is a shared subsequence of this buffer's content.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of ints remaining in this buffer, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Specified by:

slice in class IntBuffer

Returns:

The new int buffer

duplicate

public IntBuffer duplicate()

Description copied from class: IntBuffer

Creates a new int buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Specified by:

duplicate in class IntBuffer

Returns:

The new int buffer

asReadOnlyBuffer

public IntBuffer asReadOnlyBuffer()

Description copied from class: IntBuffer

Creates a new, read-only int buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer.

If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate method.

Specified by:

asReadOnlyBuffer in class IntBuffer

Returns:

The new, read-only int buffer

ix

protected int ix(int i)

get

public int get()

Description copied from class: IntBuffer

Relative get method. Reads the int at this buffer's current position, and then increments the position.

Specified by:

get in class IntBuffer

Returns:

The int at the buffer's current position

get

public int get(int i)

Description copied from class: IntBuffer

Absolute get method. Reads the int at the given index.

Specified by:

get in class IntBuffer

Parameters:

i - The index from which the int will be read

Returns:

The int at the given index

get

public IntBuffer get(int[] dst,
                     int offset,
                     int length)

Description copied from class: IntBuffer

Relative bulk get method.

This method transfers ints from this buffer into the given destination array. If there are fewer ints remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no ints are transferred and a BufferUnderflowException is thrown.

Otherwise, this method copies length ints from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form src.get(dst, off, len) has exactly the same effect as the loop

     for (int i = off; i < off + len; i++)
         dst[i] = src.get(); 

except that it first checks that there are sufficient ints in this buffer and it is potentially much more efficient.

Overrides:

get in class IntBuffer

Parameters:

dst - The array into which ints are to be written

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 ints to be written to the given array; must be non-negative and no larger than dst.length - offset

Returns:

This buffer

isDirect

public boolean isDirect()

Description copied from class: IntBuffer

Tells whether or not this int buffer is direct.

Specified by:

isDirect in class IntBuffer

Returns:

true if, and only if, this buffer is direct

isReadOnly

public boolean isReadOnly()

Description copied from class: Buffer

Tells whether or not this buffer is read-only.

Specified by:

isReadOnly in class Buffer

Returns:

true if, and only if, this buffer is read-only

put

public IntBuffer put(int x)

Description copied from class: IntBuffer

Relative put method (optional operation).

Writes the given int into this buffer at the current position, and then increments the position.

Specified by:

put in class IntBuffer

Parameters:

x - The int to be written

Returns:

This buffer

put

public IntBuffer put(int i,
                     int x)

Description copied from class: IntBuffer

Absolute put method (optional operation).

Writes the given int into this buffer at the given index.

Specified by:

put in class IntBuffer

Parameters:

i - The index at which the int will be written

x - The int value to be written

Returns:

This buffer

put

public IntBuffer put(int[] src,
                     int offset,
                     int length)

Description copied from class: IntBuffer

Relative bulk put method (optional operation).

This method transfers ints into this buffer from the given source array. If there are more ints to be copied from the array than remain in this buffer, that is, if length > remaining(), then no ints are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies length ints from the given array into this buffer, starting at the given offset in the array and at the current position of this buffer. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form dst.put(src, off, len) has exactly the same effect as the loop

     for (int i = off; i < off + len; i++)
         dst.put(a[i]); 

except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.

Overrides:

put in class IntBuffer

Parameters:

src - The array from which ints are to be read

offset - The offset within the array of the first int to be read; must be non-negative and no larger than array.length

length - The number of ints to be read from the given array; must be non-negative and no larger than array.length - offset

Returns:

This buffer

put

public IntBuffer put(IntBuffer src)

Description copied from class: IntBuffer

Relative bulk put method (optional operation).

This method transfers the ints remaining in the given source buffer into this buffer. If there are more ints remaining in the source buffer than in this buffer, that is, if src.remaining() > remaining(), then no ints are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies n = src.remaining() ints from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.

In other words, an invocation of this method of the form dst.put(src) has exactly the same effect as the loop

     while (src.hasRemaining())
         dst.put(src.get()); 

except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.

Overrides:

put in class IntBuffer

Parameters:

src - The source buffer from which ints are to be read; must not be this buffer

Returns:

This buffer

compact

public IntBuffer compact()

Description copied from class: IntBuffer

Compacts this buffer (optional operation).

The ints between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the int at index p = position() is copied to index zero, the int at index p + 1 is copied to index one, and so forth until the int at index limit() - 1 is copied to index n = limit() - 1 - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.

The buffer's position is set to the number of ints copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.

Specified by:

compact in class IntBuffer

Returns:

This buffer

order

public ByteOrder order()

Description copied from class: IntBuffer

Retrieves this buffer's byte order.

The byte order of a int buffer created by allocation or by wrapping an existing int array is the native order of the underlying hardware. The byte order of a int buffer created as a view of a byte buffer is that of the byte buffer at the moment that the view is created.

Specified by:

order in class IntBuffer

Returns:

This buffer's byte order