java.nio
public
abstract
class
java.nio.ShortBuffer
A buffer of short
s.
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;
- Use ByteBuffer.asShortBuffer
to create a short buffer based on a byte buffer.
Summary
Public Methods
capacity,
clear,
flip,
hasRemaining,
isReadOnly,
limit,
limit,
mark,
position,
position,
remaining,
reset,
rewind
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Public Methods
public
static
ShortBuffer
allocate(int capacity)
Creates a short buffer based on a new allocated short array.
Parameters
capacity
| The capacity of the new buffer |
public
final
short[]
array()
Returns the short array which this buffer is based on, if there's one.
Returns
- The short array which this buffer is based on
public
final
int
arrayOffset()
Returns the offset of the short array which this buffer is based on, if
there's one.
The offset is the index of the array corresponds to the zero position of
the buffer.
Returns
- The offset of the short array which this buffer is based on
public
abstract
ShortBuffer
asReadOnlyBuffer()
Returns a readonly buffer that shares content with this buffer.
The returned buffer is guaranteed to be a new instance, even this buffer
is readonly itself. The new buffer's position, limit, capacity and mark
are the same as this buffer.
The new buffer shares 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 readonly version of this buffer.
public
abstract
ShortBuffer
compact()
Compacts this short buffer.
The remaining short
s will be moved to the head of the
buffer, staring from position zero. Then the position is set to
remaining()
; the limit is set to capacity; the mark is
cleared.
public
int
compareTo(ShortBuffer otherBuffer)
Compare the remaining
short
s of this buffer to another
short buffer's remaining
short
s.
Parameters
otherBuffer
| Another short 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
public
abstract
ShortBuffer
duplicate()
Returns a duplicated buffer that shares content with this buffer.
The duplicated buffer's position, limit, capacity and mark are the same
as this buffer. The duplicated buffer's readonly property and byte order
are same as this buffer too.
The new buffer shares 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.
Returns
- A duplicated buffer that shares content with this buffer.
public
boolean
equals(Object other)
Tests whether this short buffer equals to another object.
If other
is not a short buffer, then false is returned.
Two short buffers are equals if, and only if, their remaining
short
s are exactly the same. Position, limit, capacity
and mark are not considered.
Parameters
other
| the object to be compared against |
Returns
- Whether this short buffer equals to another object.
public
abstract
short
get()
Returns the short at the current position and increase the position by 1.
Returns
- The short at the current position.
public
abstract
short
get(int index)
Returns a short at the specified index, and the position is not changed.
Parameters
index
| The index, must be no less than zero and less than limit |
Returns
- A short at the specified index.
public
ShortBuffer
get(short[] dest)
Reads
short
s from the current position into the specified
short array and increase the position by the number of
short
s
read.
Calling this method has the same effect as
get(dest, 0, dest.length)
.
Parameters
dest
| The destination short array |
public
ShortBuffer
get(short[] dest, int off, int len)
Reads
short
s from the current position into the specified
short array, starting from the specified offset, and increase the
position by the number of
short
s read.
Parameters
dest
| The target short array |
off
| The offset of the short array, must be no less than zero and
no greater than dest.length |
len
| The number of short s to read, must be no less
than zero and no greater than dest.length - off |
public
final
boolean
hasArray()
Returns whether this buffer is based on a short array and is read/write.
If this buffer is readonly, then false is returned.
Returns
- Whether this buffer is based on a short array and is read/write.
public
int
hashCode()
Hash code is calculated from the remaining
short
s.
Position, limit, capacity and mark don't affect the hash code.
Returns
- The hash code calculated from the remaining
short
s.
public
abstract
boolean
isDirect()
Returns true if this buffer is direct.
A direct buffer will try its best to take advantage of native memory APIs
and it may not stay in java heap, thus not affected by GC.
A short buffer is direct, if it is based on a byte buffer and the byte
buffer is direct.
Returns
- True if this buffer is direct.
public
abstract
ByteOrder
order()
Returns the byte order used by this buffer when converting
short
s from/to
byte
s.
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
short
s from/to byte
s.
Writes all the remaining
short
s of the
src
short buffer to this buffer's current position, and increase both
buffers' position by the number of
short
s copied.
Parameters
src
| The source short buffer |
public
abstract
ShortBuffer
put(int index, short s)
Write a short to the specified index of this buffer and the position is
not changed.
Parameters
index
| The index, must be no less than zero and less than the limit |
s
| The short to write |
public
ShortBuffer
put(short[] src, int off, int len)
Writes
short
s in the given short array, starting from the
specified offset, to the current position and increase the position by
the number of
short
s written.
Parameters
src
| The source short array |
off
| The offset of short array, must be no less than zero and no
greater than src.length |
len
| The number of short s to write, must be no less
than zero and no greater than src.length - off |
public
abstract
ShortBuffer
put(short s)
Writes the given short to the current position and increase the position
by 1.
public
final
ShortBuffer
put(short[] src)
Writes
short
s in the given short array to the current
position and increase the position by the number of
short
s
written.
Calling this method has the same effect as
put(src, 0, src.length)
.
Parameters
src
| The source short array |
public
abstract
ShortBuffer
slice()
Returns a sliced buffer that shares 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 unset. The new buffer's
readonly property and byte order are same as this buffer.
The new buffer shares 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.
Returns
- A sliced buffer that shares content with this buffer.
public
String
toString()
Returns a string represents the state of this short buffer.
Returns
- A string represents the state of this short buffer.
public
static
ShortBuffer
wrap(short[] array, int start, int len)
Creates new a short buffer by wrapping the given short array.
The new buffer's position will be start
, limit will be
start + len
, capacity will be the length of the array.
Parameters
array
| The short array which the new buffer will be based on |
start
| The start index, must be no less than zero and no greater than
array.length |
len
| The length, must be no less than zero and no greater than
array.length - start |
public
static
ShortBuffer
wrap(short[] array)
Creates a new short buffer by wrapping the given short array.
Calling this method has the same effect as
wrap(array, 0, array.length)
.
Parameters
array
| The short array which the new buffer will be based on |