public abstract class ShortBuffer extends Buffer implements Comparable<ShortBuffer>
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.Modifier and Type | Method and Description |
---|---|
static ShortBuffer |
allocate(int capacity)
Creates a short buffer based on a newly allocated short array.
|
short[] |
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 ShortBuffer |
asReadOnlyBuffer()
Returns a read-only buffer that shares its content with this buffer.
|
abstract ShortBuffer |
compact()
Compacts this short buffer.
|
int |
compareTo(ShortBuffer otherBuffer)
Compare the remaining shorts of this buffer to another short buffer's
remaining shorts.
|
abstract ShortBuffer |
duplicate()
Returns a duplicated buffer that shares its content with this buffer.
|
boolean |
equals(Object other)
Checks whether this short buffer is equal to another object.
|
abstract short |
get()
Returns the short at the current position and increases the position by
1.
|
abstract short |
get(int index)
Returns the short at the specified index; the position is not changed.
|
ShortBuffer |
get(short[] dst)
Reads shorts from the current position into the specified short array and
increases the position by the number of shorts read.
|
ShortBuffer |
get(short[] dst,
int dstOffset,
int shortCount)
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.
|
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 shorts from/to
bytes.
|
abstract ShortBuffer |
put(int index,
short s)
Writes a short to the specified index of this buffer; the position is not
changed.
|
abstract ShortBuffer |
put(short s)
Writes the given short to the current position and increases the position
by 1.
|
ShortBuffer |
put(short[] src)
Writes shorts from the given short array to the current position and
increases the position by the number of shorts written.
|
ShortBuffer |
put(short[] src,
int srcOffset,
int shortCount)
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.
|
ShortBuffer |
put(ShortBuffer src)
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. |
abstract ShortBuffer |
slice()
Returns a sliced buffer that shares its content with this buffer.
|
static ShortBuffer |
wrap(short[] array)
Creates a new short buffer by wrapping the given short array.
|
static ShortBuffer |
wrap(short[] array,
int start,
int shortCount)
Creates a new short buffer by wrapping the given short array.
|
public static ShortBuffer allocate(int capacity)
capacity
- the capacity of the new buffer.IllegalArgumentException
- if capacity
is less than zero.public static ShortBuffer wrap(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.public static ShortBuffer wrap(short[] array, int start, int shortCount)
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.public final short[] array()
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.)
public final int arrayOffset()
Buffer
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.)
arrayOffset
in class Buffer
public abstract ShortBuffer asReadOnlyBuffer()
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.
public abstract ShortBuffer compact()
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.public int compareTo(ShortBuffer otherBuffer)
compareTo
in interface Comparable<ShortBuffer>
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.public abstract ShortBuffer duplicate()
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 buffer's position, limit and mark are independent.
public boolean equals(Object other)
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.
equals
in class Object
other
- the object to compare with this short buffer.true
if this short buffer is equal to other
,
false
otherwise.Object.hashCode()
public abstract short get()
BufferUnderflowException
- if the position is equal or greater than limit.public ShortBuffer get(short[] dst)
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()
.public ShortBuffer get(short[] dst, int dstOffset, int shortCount)
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()
.public abstract short get(int index)
index
- the index, must not be negative and less than limit.IndexOutOfBoundsException
- if index is invalid.public final boolean hasArray()
Buffer
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
.public int hashCode()
hashCode
in class Object
Object.equals(java.lang.Object)
public abstract boolean isDirect()
A short buffer is direct if it is based on a byte buffer and the byte buffer is direct.
public abstract ByteOrder order()
If this buffer is not based on a byte buffer, then always return the platform's native byte order.
public abstract ShortBuffer put(short s)
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.public final ShortBuffer put(short[] src)
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.public ShortBuffer put(short[] src, int srcOffset, int shortCount)
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.public ShortBuffer put(ShortBuffer src)
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.public abstract ShortBuffer put(int index, short s)
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.public abstract ShortBuffer slice()
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 buffer's position, limit and mark are independent.