This class defines four categories of operations upon int buffers:
Absolute and relative get and
put methods that read and write
single ints;
Absolute and relative bulk get
methods that transfer contiguous sequences of ints from this buffer
into an array;
Absolute and relative bulk put
methods that transfer contiguous sequences of ints from an
int array or some other int
buffer into this buffer;
A method for compacting
an int buffer.
Int buffers can be created either by allocation, which allocates space for the buffer's
content, by wrapping an existing
int array into a buffer, or by creating a
view of an existing byte buffer.
Like a byte buffer, an int buffer is either direct or non-direct. A
int buffer created via the wrap methods of this class will
be non-direct. An int buffer created as a view of a byte buffer will
be direct if, and only if, the byte buffer itself is direct. Whether or not
an int buffer is direct may be determined by invoking the isDirect method.
Methods in this class that do not otherwise have a value to return are specified to return the buffer upon which they are invoked. This allows method invocations to be chained.
| Modifier and Type | Field and Description |
|---|---|
| private static final long | |
| pack-priv final int[] | |
| pack-priv boolean | |
| pack-priv final int |
| Access | Constructor and Description |
|---|---|
| pack-priv | |
| pack-priv | |
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| public static IntBuffer | Returns: The new int bufferThe new buffer's capacity, in ints capacity)Allocates a new int buffer. |
| public final int[] | Returns: The array that backs this bufferImplements abstract java. Returns the int array that backs this buffer (optional operation). |
| public final int | Returns: The offset within this buffer's array of the first element of the bufferImplements abstract java. Returns the offset within this buffer's backing array of the first element of the buffer (optional operation). |
| public abstract IntBuffer | Returns: The new, read-only int bufferCreates a new, read-only int buffer that shares this buffer's content. |
| pack-priv Object | |
| public final IntBuffer | |
| public abstract IntBuffer | |
| private static int | |
| public int | Returns: A negative integer, zero, or a positive integer as this buffer is less than, equal to, or greater than the given bufferImplements java. Compares this buffer to another. |
| public abstract IntBuffer | Returns: The new int bufferImplements abstract java. Creates a new int buffer that shares this buffer's content. |
| public boolean | Returns: true if, and only if, this buffer is equal to the
given objectThe object to which this buffer is to be compared ob)Overrides java. Tells whether or not this buffer is equal to another object. |
| public final IntBuffer | |
| public abstract int | |
| public abstract int | Returns: The int at the given indexThe index from which the int will be read index)Absolute get method. |
| public IntBuffer | Returns: This bufferThe array into which ints are to be written dst, int The offset within the array of the first int to be
written; must be non-negative and no larger than
offset, int dst.lengthThe maximum number of ints to be written to the given
array; must be non-negative and no larger than
length)dst.length - offsetRelative bulk get method. |
| public IntBuffer | |
| public IntBuffer | Returns: This bufferThe index in this buffer from which the first int will be
read; must be non-negative and less than index, int[] limit()The destination array dst, int The offset within the array of the first int to be
written; must be non-negative and less than
offset, int dst.lengthThe number of ints to be written to the given array;
must be non-negative and no larger than the smaller of
length)limit() - index and dst.length - offsetAbsolute bulk get method. |
| public IntBuffer | Returns: This bufferThe index in this buffer from which the first int will be
read; must be non-negative and less than index, int[] limit()The destination array dst)Absolute bulk get method. |
| pack-priv IntBuffer | |
| public final boolean | Returns: true if, and only if, this buffer
is backed by an array and is not read-onlyImplements abstract java. Tells whether or not this buffer is backed by an accessible int array. |
| public int | Returns: The current hash code of this bufferOverrides java. Returns the current hash code of this buffer. |
| pack-priv AbstractMemorySegmentImpl | heapSegment(Object base, long offset, long length, boolean readOnly, MemorySessionImpl bufferScope)
Implements abstract java.
|
| public abstract boolean | Returns: true if, and only if, this buffer is directImplements abstract java. Tells whether or not this int buffer is direct. |
| public final IntBuffer | |
| public final IntBuffer | |
| public int | |
| public abstract ByteOrder | |
| public final IntBuffer | |
| public abstract IntBuffer | |
| public abstract IntBuffer | Returns: This bufferThe index at which the int will be written index, int The int value to be written i)Absolute put method (optional operation). |
| public IntBuffer | |
| public IntBuffer | Returns: This bufferThe index in this buffer at which the first int will be
written; must be non-negative and less than index, IntBuffer limit()The buffer from which ints are to be read src, int The index within the source buffer of the first int to be
read; must be non-negative and less than offset, int src.limit()The number of ints to be read from the given buffer;
must be non-negative and no larger than the smaller of
length)limit() - index and src.limit() - offsetAbsolute bulk put method (optional operation). |
| public IntBuffer | Returns: This bufferThe array from which ints are to be read src, int The offset within the array of the first int to be read;
must be non-negative and no larger than offset, int src.lengthThe number of ints to be read from the given array;
must be non-negative and no larger than
length)src.length - offsetRelative bulk put method (optional operation). |
| public final IntBuffer | |
| public IntBuffer | Returns: This bufferThe index in this buffer at which the first int will be
written; must be non-negative and less than index, int[] limit()The array from which ints are to be read src, int The offset within the array of the first int to be read;
must be non-negative and less than offset, int src.lengthThe number of ints to be read from the given array;
must be non-negative and no larger than the smaller of
length)limit() - index and src.length - offsetAbsolute bulk put method (optional operation). |
| public IntBuffer | Returns: This bufferThe index in this buffer at which the first int will be
written; must be non-negative and less than index, int[] limit()The array from which ints are to be read src)Absolute bulk put method (optional operation). |
| pack-priv IntBuffer | |
| pack-priv void | |
| public final IntBuffer | reset()
Overrides java. Resets this buffer's position to the previously-marked position. |
| public final IntBuffer | |
| pack-priv int | scaleShifts()
Implements abstract java. Returns the scale shifts for this Buffer. |
| public abstract IntBuffer | Returns: The new int bufferImplements abstract java. Creates a new int buffer whose content is a shared subsequence of this buffer's content. |
| public abstract IntBuffer | Returns: The new bufferThe position in this buffer at which the content of the new
buffer will start; must be non-negative and no larger than
index, int limit()The number of elements the new buffer will contain; must be
non-negative and no larger than length)limit() - indexImplements abstract java. Creates a new int buffer whose content is a shared subsequence of this buffer's content. |
| public String | Returns: A summary stringOverrides java. Returns a string summarizing the state of this buffer. |
| public static IntBuffer | Returns: The new int bufferThe array that will back the new buffer array, int The offset of the subarray to be used; must be non-negative and
no larger than offset, int array.length. The new buffer's position
will be set to this value.The length of the subarray to be used;
must be non-negative and no larger than
length)array.length - offset.
The new buffer's limit will be set to offset + length.Wraps an int array into a buffer. |
| public static IntBuffer | Returns: The new int bufferThe array that will back this buffer array)Wraps an int array into a buffer. |
| ARRAY_BASE_OFFSET | back to summary |
|---|---|
| private static final long ARRAY_BASE_OFFSET | |
| hb | back to summary |
|---|---|
| pack-priv final int[] hb | |
| isReadOnly | back to summary |
|---|---|
| pack-priv boolean isReadOnly | |
| offset | back to summary |
|---|---|
| pack-priv final int offset | |
| IntBuffer | back to summary |
|---|---|
| pack-priv IntBuffer(int mark, int pos, int lim, int cap, int[] hb, int offset, MemorySegment segment) | |
| IntBuffer | back to summary |
|---|---|
| pack-priv IntBuffer(int mark, int pos, int lim, int cap, MemorySegment segment) | |
| IntBuffer | back to summary |
|---|---|
| pack-priv IntBuffer(int[] hb, long addr, int cap, MemorySegment segment) | |
| allocate | back to summary |
|---|---|
| public static IntBuffer allocate(int capacity) Allocates a new int buffer. The new buffer's position will be zero, its limit will be its
capacity, its mark will be undefined, each of its elements will be
initialized to zero, and its byte order will be
the
| |
| array | back to summary |
|---|---|
| public final int[] array() Implements abstract java. Returns the int array that backs this buffer (optional operation). Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa. Invoke the
| |
| arrayOffset | back to summary |
|---|---|
| public final int arrayOffset() Implements abstract java. Returns the offset within this buffer's backing array of the first element of the buffer (optional operation). If this buffer is backed by an array then buffer position p
corresponds to array index p + Invoke the
| |
| asReadOnlyBuffer | back to summary |
|---|---|
| public abstract IntBuffer asReadOnlyBuffer() 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, mark values, and byte order 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
| |
| base | back to summary |
|---|---|
| pack-priv Object base() Implements abstract java.
| |
| clear | back to summary |
|---|---|
| public final IntBuffer clear() Overrides java. Doc from java. Clears this buffer. The position is set to zero, the limit is set to the capacity, and the mark is discarded. Invoke this method before using a sequence of channel-read or put operations to fill this buffer. For example: buf.clear(); // Prepare buffer for reading in.read(buf); // Read data This method does not actually erase the data in the buffer, but it is named as if it did because it will most often be used in situations in which that might as well be the case.
| |
| compact | back to summary |
|---|---|
| public abstract IntBuffer compact() 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 = 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.
| |
| compare | back to summary |
|---|---|
| private static int compare(int x, int y) | |
| compareTo | back to summary |
|---|---|
| public int compareTo(IntBuffer that) Implements java. Compares this buffer to another. Two int buffers are compared by comparing their sequences of
remaining elements lexicographically, without regard to the starting
position of each sequence within its corresponding buffer.
Pairs of A int buffer is not comparable to any other type of object.
| |
| duplicate | back to summary |
|---|---|
| public abstract IntBuffer duplicate() Implements abstract java. 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, mark values, and byte order 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. | |
| equals | back to summary |
|---|---|
| public boolean equals(Object ob) Overrides java. Tells whether or not this buffer is equal to another object. Two int buffers are equal if, and only if,
A int buffer is not equal to any other type of object.
| |
| flip | back to summary |
|---|---|
| public final IntBuffer flip() Overrides java. Doc from java. Flips this buffer. The limit is set to the current position and then the position is set to zero. If the mark is defined then it is discarded. After a sequence of channel-read or put operations, invoke this method to prepare for a sequence of channel-write or relative get operations. For example: buf.put(magic); // Prepend header in.read(buf); // Read data into rest of buffer buf.flip(); // Flip buffer out.write(buf); // Write header + data to channel This method is often used in conjunction with the
| |
| get | back to summary |
|---|---|
| public abstract int get() Relative get method. Reads the int at this buffer's current position, and then increments the position.
| |
| get | back to summary |
|---|---|
| public abstract int get(int index) Absolute get method. Reads the int at the given index.
| |
| get | back to summary |
|---|---|
| public IntBuffer get(int[] dst, int offset, int length) 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
Otherwise, this method copies In other words, an invocation of this method of the form
for (int i = off; i < off + len; i++) dst[i] = src.get();
| |
| get | back to summary |
|---|---|
| public IntBuffer get(int[] dst) Relative bulk get method. This method transfers ints from this buffer into the given
destination array. An invocation of this method of the form
src.get(a, 0, a.length)
| |
| get | back to summary |
|---|---|
| public IntBuffer get(int index, int[] dst, int offset, int length) Absolute bulk get method. This method transfers An invocation of this method of the form
for (int i = offset, j = index; i < offset + length; i++, j++) dst[i] = src.get(j);
| |
| get | back to summary |
|---|---|
| public IntBuffer get(int index, int[] dst) Absolute bulk get method. This method transfers ints from this buffer into the given
destination array. The position of this buffer is unchanged. An
invocation of this method of the form
src.get(index, dst, 0, dst.length)
| |
| getArray | back to summary |
|---|---|
| pack-priv IntBuffer getArray(int index, int[] dst, int offset, int length) | |
| hasArray | back to summary |
|---|---|
| public final boolean hasArray() Implements abstract java. Tells whether or not this buffer is backed by an accessible int array. If this method returns
| |
| hashCode | back to summary |
|---|---|
| public int hashCode() Overrides java. Returns the current hash code of this buffer. The hash code of a int buffer depends only upon its remaining
elements; that is, upon the elements from Because buffer hash codes are content-dependent, it is inadvisable to use buffers as keys in hash maps or similar data structures unless it is known that their contents will not change.
| |
| heapSegment | back to summary |
|---|---|
| pack-priv AbstractMemorySegmentImpl heapSegment(Object base, long offset, long length, boolean readOnly, MemorySessionImpl bufferScope) Implements abstract java.
| |
| isDirect | back to summary |
|---|---|
| public abstract boolean isDirect() Implements abstract java. Tells whether or not this int buffer is direct.
| |
| limit | back to summary |
|---|---|
| public final IntBuffer limit(int newLimit) Overrides java. Doc from java. Sets this buffer's limit. If the position is larger than the new limit then it is set to the new limit. If the mark is defined and larger than the new limit then it is discarded.
| |
| mark | back to summary |
|---|---|
| public final IntBuffer mark() Overrides java. Doc from java. Sets this buffer's mark at its position.
| |
| mismatch | back to summary |
|---|---|
| public int mismatch(IntBuffer that) Finds and returns the relative index of the first mismatch between this
buffer and a given buffer. The index is relative to the
If the two buffers share a common prefix then the returned index is the length of the common prefix and it follows that there is a mismatch between the two buffers at that index within the respective buffers. If one buffer is a proper prefix of the other then the returned index is the smaller of the remaining elements in each buffer, and it follows that the index is only valid for the buffer with the larger number of remaining elements. Otherwise, there is no mismatch.
| |
| order | back to summary |
|---|---|
| public abstract ByteOrder order() Retrieves this buffer's byte order. The byte order of an int buffer created by allocation or by
wrapping an existing
| |
| position | back to summary |
|---|---|
| public final IntBuffer position(int newPosition) Overrides java. Doc from java. Sets this buffer's position. If the mark is defined and larger than the new position then it is discarded.
| |
| put | back to summary |
|---|---|
| public abstract IntBuffer put(int i) Relative put method (optional operation). Writes the given int into this buffer at the current position, and then increments the position.
| |
| put | back to summary |
|---|---|
| public abstract IntBuffer put(int index, int i) Absolute put method (optional operation). Writes the given int into this buffer at the given index.
| |
| put | back to summary |
|---|---|
| public IntBuffer put(IntBuffer src) 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
Otherwise, this method copies
n = In other words, an invocation of this method of the form
while (src.hasRemaining()) dst.put(src.get());
| |
| put | back to summary |
|---|---|
| public IntBuffer put(int index, IntBuffer src, int offset, int length) Absolute bulk put method (optional operation). This method transfers In other words, an invocation of this method of the form
for (int i = offset, j = index; i < offset + length; i++, j++) dst.put(j, src.get(i));
| |
| put | back to summary |
|---|---|
| public IntBuffer put(int[] src, int offset, int length) 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
Otherwise, this method copies In other words, an invocation of this method of the form
for (int i = off; i < off + len; i++) dst.put(src[i]);
| |
| put | back to summary |
|---|---|
| public final IntBuffer put(int[] src) Relative bulk put method (optional operation). This method transfers the entire content of the given source
int array into this buffer. An invocation of this method of the
form dst.put(a, 0, a.length)
| |
| put | back to summary |
|---|---|
| public IntBuffer put(int index, int[] src, int offset, int length) Absolute bulk put method (optional operation). This method transfers An invocation of this method of the form
for (int i = offset, j = index; i < offset + length; i++, j++) dst.put(j, src[i]);
| |
| put | back to summary |
|---|---|
| public IntBuffer put(int index, int[] src) Absolute bulk put method (optional operation). This method copies ints into this buffer from the given source
array. The position of this buffer is unchanged. An invocation of this
method of the form dst.put(index, src, 0, src.length);
| |
| putArray | back to summary |
|---|---|
| pack-priv IntBuffer putArray(int index, int[] src, int offset, int length) | |
| putBuffer | back to summary |
|---|---|
| pack-priv void putBuffer(int pos, IntBuffer src, int srcPos, int n) | |
| reset | back to summary |
|---|---|
| public final IntBuffer reset() Overrides java. Doc from java. Resets this buffer's position to the previously-marked position. Invoking this method neither changes nor discards the mark's value.
| |
| rewind | back to summary |
|---|---|
| public final IntBuffer rewind() Overrides java. Doc from java. Rewinds this buffer. The position is set to zero and the mark is discarded. Invoke this method before a sequence of channel-write or get operations, assuming that the limit has already been set appropriately. For example: out.write(buf); // Write remaining data buf.rewind(); // Rewind buffer buf.get(array); // Copy data into array
| |
| scaleShifts | back to summary |
|---|---|
| pack-priv int scaleShifts() Implements abstract java. Doc from java. Returns the scale shifts for this Buffer. The scale shifts are: ByteBuffer: 0 ShortBuffer, CharBuffer: 1 IntBuffer, FloatBuffer: 2 LongBuffer, DoubleBuffer: 3
| |
| slice | back to summary |
|---|---|
| public abstract IntBuffer slice() Implements abstract java. 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, its mark will be undefined, and its byte order will be identical to that 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. | |
| slice | back to summary |
|---|---|
| public abstract IntBuffer slice(int index, int length) Implements abstract java. 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 position The new buffer's position will be zero, its capacity and its limit
will be
| |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Returns a string summarizing the state of this buffer.
| |
| wrap | back to summary |
|---|---|
| public static IntBuffer wrap(int[] array, int offset, int length) Wraps an int array into a buffer. The new buffer will be backed by the given int array;
that is, modifications to the buffer will cause the array to be modified
and vice versa. The new buffer's capacity will be
| |
| wrap | back to summary |
|---|---|
| public static IntBuffer wrap(int[] array) Wraps an int array into a buffer. The new buffer will be backed by the given int array;
that is, modifications to the buffer will cause the array to be modified
and vice versa. The new buffer's capacity and limit will be
| |