java.lang.Object | ||
↳ | java.nio.Buffer | |
↳ | java.nio.ShortBuffer |
A buffer of shorts.
A short buffer can be created in either of the following ways:
Allocate
a new short array and create a buffer
based on it;Wrap
an existing short array to create a new
buffer;ByteBuffer.asShortBuffer
to create a short buffer based on a byte buffer.Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a short buffer based on a newly allocated short array.
| |||||||||||
Returns the array that backs this buffer (optional operation).
| |||||||||||
Returns the offset into the array returned by
array of the first
element of the buffer (optional operation). | |||||||||||
Returns a read-only buffer that shares its content with this buffer.
| |||||||||||
Compacts this short buffer.
| |||||||||||
Compare the remaining shorts of this buffer to another short buffer's
remaining shorts.
| |||||||||||
Returns a duplicated buffer that shares its content with this buffer.
| |||||||||||
Checks whether this short buffer is equal to another object.
| |||||||||||
Returns the short at the specified index; the position is not changed.
| |||||||||||
Reads shorts from the current position into the specified short array,
starting from the specified offset, and increases the position by the
number of shorts read.
| |||||||||||
Reads shorts from the current position into the specified short array and
increases the position by the number of shorts read.
| |||||||||||
Returns the short at the current position and increases the position by
1.
| |||||||||||
Returns true if
array and arrayOffset won't throw. | |||||||||||
Calculates this buffer's hash code from the remaining chars.
| |||||||||||
Indicates whether this buffer is direct.
| |||||||||||
Returns the byte order used by this buffer when converting shorts from/to
bytes.
| |||||||||||
Writes shorts from the given short array, starting from the specified
offset, to the current position and increases the position by the number
of shorts written.
| |||||||||||
Writes shorts from the given short array to the current position and
increases the position by the number of shorts written.
| |||||||||||
Writes the given short to the current position and increases the position
by 1.
| |||||||||||
Writes all the remaining shorts of the
src short buffer to this
buffer's current position, and increases both buffers' position by the
number of shorts copied. | |||||||||||
Writes a short to the specified index of this buffer; the position is not
changed.
| |||||||||||
Returns a sliced buffer that shares its content with this buffer.
| |||||||||||
Creates a new short buffer by wrapping the given short array.
| |||||||||||
Creates a new short buffer by wrapping the given short array.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.nio.Buffer
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Comparable
|
Creates a short buffer based on a newly allocated short array.
capacity | the capacity of the new buffer. |
---|
IllegalArgumentException | if capacity is less than zero.
|
---|
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.)
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.)
Returns a read-only buffer that shares its content with this buffer.
The returned buffer is guaranteed to be a new instance, even if 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.
Compacts this short buffer.
The remaining shorts 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. |
---|
Compare the remaining shorts of this buffer to another short buffer's remaining shorts.
otherBuffer | another short buffer. |
---|
otherBuffer
; 0 if
this equals to otherBuffer
; a positive value if this is
greater than otherBuffer
.ClassCastException | if otherBuffer is not a short buffer.
|
---|
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.
Checks whether this short buffer is equal to another object.
If other
is not a short buffer then false
is returned.
Two short buffers are equal if and only if their remaining shorts are
exactly the same. Position, limit, capacity and mark are not considered.
other | the object to compare with this short buffer. |
---|
true
if this short buffer is equal to other
,
false
otherwise.
Returns the short at the specified index; the position is not changed.
index | the index, must not be negative and less than limit. |
---|
IndexOutOfBoundsException | if index is invalid. |
---|
Reads shorts from the current position into the specified short array, starting from the specified offset, and increases the position by the number of shorts read.
dst | the target short array. |
---|---|
dstOffset | the offset of the short array, must not be negative and not
greater than dst.length . |
shortCount | the number of shorts to read, must be no less than zero and
not greater than dst.length - dstOffset . |
IndexOutOfBoundsException | if either dstOffset or shortCount is invalid. |
---|---|
BufferUnderflowException | if shortCount is greater than remaining() .
|
Reads shorts from the current position into the specified short array and increases the position by the number of shorts read.
Calling this method has the same effect as
get(dst, 0, dst.length)
.
dst | the destination short array. |
---|
BufferUnderflowException | if dst.length is greater than remaining() .
|
---|
Returns the short at the current position and increases the position by 1.
BufferUnderflowException | if the position is equal or greater than limit. |
---|
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
.
Calculates this buffer's hash code from the remaining chars. The position, limit, capacity and mark don't affect the hash code.
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.
A short buffer is direct if it is based on a byte buffer and the byte buffer is direct.
true
if this buffer is direct, false
otherwise.
Returns the byte order used by this buffer when converting shorts from/to bytes.
If this buffer is not based on a byte buffer, then always return the platform's native byte order.
Writes shorts from the given short array, starting from the specified offset, to the current position and increases the position by the number of shorts written.
src | the source short array. |
---|---|
srcOffset | the offset of short array, must not be negative and not
greater than src.length . |
shortCount | the number of shorts to write, must be no less than zero and
not greater than src.length - srcOffset . |
BufferOverflowException | if remaining() is less than shortCount . |
---|---|
IndexOutOfBoundsException | if either srcOffset or shortCount is invalid. |
ReadOnlyBufferException | if no changes may be made to the contents of this buffer. |
Writes shorts from the given short array to the current position and increases the position by the number of shorts written.
Calling this method has the same effect as
put(src, 0, src.length)
.
src | the source short array. |
---|
BufferOverflowException | if remaining() is less than src.length . |
---|---|
ReadOnlyBufferException | if no changes may be made to the contents of this buffer. |
Writes the given short to the current position and increases the position by 1.
s | the short to write. |
---|
BufferOverflowException | if position is equal or greater than limit. |
---|---|
ReadOnlyBufferException | if no changes may be made to the contents of this buffer. |
Writes all the remaining shorts of the src
short buffer to this
buffer's current position, and increases both buffers' position by the
number of shorts copied.
src | the source short 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. |
Writes a short to the specified index of this buffer; the position is not changed.
index | the index, must not be negative and less than the limit. |
---|---|
s | the short to write. |
IndexOutOfBoundsException | if index is invalid. |
---|---|
ReadOnlyBufferException | if no changes may be made to the contents of this buffer. |
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.
Creates a new short buffer by wrapping the given short array.
Calling this method has the same effect as
wrap(array, 0, array.length)
.
array | the short array which the new buffer will be based on. |
---|
Creates a new short buffer by wrapping the given short array.
The new buffer's position will be start
, limit will be
start + shortCount
, capacity will be the length of the array.
array | the short array which the new buffer will be based on. |
---|---|
start | the start index, must not be negative and not greater than
array.length . |
shortCount | the length, must not be negative and not greater than
array.length - start . |
IndexOutOfBoundsException | if either start or shortCount is invalid.
|
---|