| java.lang.Object
 java.nio.Buffer
java.nio.ShortBuffer
All known Subclasses: java.nio.ShortToByteBufferAdapter, java.nio.ShortArrayBuffer,
| ShortBuffer | | abstract public class ShortBuffer extends Buffer implements Comparable<ShortBuffer>(Code) | | A buffer of shorts.
A short buffer can be created in either of the following ways:
|
| Constructor Summary | |
| | ShortBuffer(int capacity)
Constructs a ShortBuffer with given capacity. |
| Method Summary | |
| public static ShortBuffer | allocate(int capacity)
Creates a short buffer based on a new allocated short array. | | final public short[] | array()
Returns the short array which this buffer is based on, if there's one. | | final public int | arrayOffset()
Returns the offset of the short array which this buffer is based on, if
there's one. | | abstract public 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. | | abstract public ShortBuffer | compact()
Compacts this short buffer.
The remaining shorts will be moved to the head of the
buffer, staring from position zero. | | public int | compareTo(ShortBuffer otherBuffer)
Compare the remaining shorts of this buffer to another
short buffer's remaining shorts. | | abstract public 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. | | 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
shorts are exactly the same. | | abstract public short | get()
Returns the short at the current position and increase the position by 1. | | public ShortBuffer | get(short[] dest)
Reads shorts from the current position into the specified
short array and increase the position by the number of shorts
read. | | public ShortBuffer | get(short[] dest, int off, int len)
Reads shorts from the current position into the specified
short array, starting from the specified offset, and increase the
position by the number of shorts read. | | abstract public short | get(int index)
Returns a short at the specified index, and the position is not changed. | | final public boolean | hasArray()
Returns whether this buffer is based on a short array and is read/write. | | public int | hashCode()
Hash code is calculated from the remaining shorts. | | abstract public boolean | isDirect()
Returns true if this buffer is direct. | | abstract public ByteOrder | order()
Returns the byte order used by this buffer when converting
shorts from/to bytes. | | abstract short[] | protectedArray()
Child class implements this method to realize array(). | | abstract int | protectedArrayOffset()
Child class implements this method to realize arrayOffset(). | | abstract boolean | protectedHasArray()
Child class implements this method to realize hasArray(). | | abstract public ShortBuffer | put(short s)
Writes the given short to the current position and increase the position
by 1. | | final public ShortBuffer | put(short[] src)
Writes shorts in the given short array to the current
position and increase the position by the number of shorts
written. | | public ShortBuffer | put(short[] src, int off, int len)
Writes shorts in the given short array, starting from the
specified offset, to the current position and increase the position by
the number of shorts written. | | public ShortBuffer | put(ShortBuffer src)
Writes all the remaining shorts of the src
short buffer to this buffer's current position, and increase both
buffers' position by the number of shorts copied. | | abstract public ShortBuffer | put(int index, short s)
Write a short to the specified index of this buffer and the position is
not changed. | | abstract public 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. | | public String | toString()
Returns a string represents the state of this short buffer. | | public static ShortBuffer | wrap(short[] array)
Creates a new short buffer by wrapping the given short array. | | public static ShortBuffer | wrap(short[] array, int start, int len)
Creates new a short buffer by wrapping the given short array. |
| ShortBuffer | | ShortBuffer(int capacity)(Code) | | Constructs a ShortBuffer with given capacity.
Parameters:
capacity - The capacity of the buffer |
| allocate | | public static ShortBuffer allocate(int capacity)(Code) | | Creates a short buffer based on a new allocated short array.
Parameters:
capacity - The capacity of the new buffer The created short buffer
throws:
IllegalArgumentException - If capacity is less than zero |
| array | | final public short[] array()(Code) | | Returns the short array which this buffer is based on, if there's one.
The short array which this buffer is based on
exception:
ReadOnlyBufferException - If this buffer is based on an array, but it is readonly
exception:
UnsupportedOperationException - If this buffer is not based on an array |
| arrayOffset | | final public int arrayOffset()(Code) | | 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.
The offset of the short array which this buffer is based on
exception:
ReadOnlyBufferException - If this buffer is based on an array, but it is readonly
exception:
UnsupportedOperationException - If this buffer is not based on an array |
| asReadOnlyBuffer | | abstract public ShortBuffer asReadOnlyBuffer()(Code) | | 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.
A readonly version of this buffer. |
| compact | | abstract public ShortBuffer compact()(Code) | | Compacts this short buffer.
The remaining shorts 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.
This buffer
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| compareTo | | public int compareTo(ShortBuffer otherBuffer)(Code) | | Compare the remaining shorts of this buffer to another
short buffer's remaining shorts.
Parameters:
otherBuffer - Another short buffer a negative value if this is less than other; 0 ifthis equals to other; a positive value if this isgreater than other
exception:
ClassCastException - If other is not a short buffer |
| duplicate | | abstract public ShortBuffer duplicate()(Code) | | 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.
A duplicated buffer that shares content with this buffer. |
| equals | | public boolean equals(Object other)(Code) | | 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
shorts are exactly the same. Position, limit, capacity
and mark are not considered.
Parameters:
other - the object to be compared against Whether this short buffer equals to another object. |
| get | | abstract public short get()(Code) | | Returns the short at the current position and increase the position by 1.
The short at the current position.
exception:
BufferUnderflowException - If the position is equal or greater than limit |
| get | | public ShortBuffer get(short[] dest)(Code) | | Reads shorts from the current position into the specified
short array and increase the position by the number of shorts
read.
Calling this method has the same effect as
get(dest, 0, dest.length).
Parameters:
dest - The destination short array This buffer
exception:
BufferUnderflowException - if dest.length is greater thanremaining() |
| get | | public ShortBuffer get(short[] dest, int off, int len)(Code) | | Reads shorts from the current position into the specified
short array, starting from the specified offset, and increase the
position by the number of shorts read.
Parameters:
dest - The target short array
Parameters:
off - The offset of the short array, must be no less than zero andno greater than dest.length
Parameters:
len - The number of shorts to read, must be no lessthan zero and no greater than dest.length - off This buffer
exception:
IndexOutOfBoundsException - If either off or len isinvalid
exception:
BufferUnderflowException - If len is greater thanremaining() |
| get | | abstract public short get(int index)(Code) | | 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 A short at the specified index.
exception:
IndexOutOfBoundsException - If index is invalid |
| hasArray | | final public boolean hasArray()(Code) | | Returns whether this buffer is based on a short array and is read/write.
If this buffer is readonly, then false is returned.
Whether this buffer is based on a short array and is read/write. |
| hashCode | | public int hashCode()(Code) | | Hash code is calculated from the remaining shorts.
Position, limit, capacity and mark don't affect the hash code.
The hash code calculated from the remaining shorts. |
| isDirect | | abstract public boolean isDirect()(Code) | | 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.
True if this buffer is direct. |
| order | | abstract public ByteOrder order()(Code) | | 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.
The byte order used by this buffer when convertingshorts from/to bytes. |
| protectedArray | | abstract short[] protectedArray()(Code) | | Child class implements this method to realize array().
see array() |
| protectedArrayOffset | | abstract int protectedArrayOffset()(Code) | | Child class implements this method to realize arrayOffset().
see arrayOffset() |
| protectedHasArray | | abstract boolean protectedHasArray()(Code) | | Child class implements this method to realize hasArray().
see hasArray() |
| put | | abstract public ShortBuffer put(short s)(Code) | | Writes the given short to the current position and increase the position
by 1.
Parameters:
s - The short to write This buffer
exception:
BufferOverflowException - If position is equal or greater than limit
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | final public ShortBuffer put(short[] src)(Code) | | Writes shorts in the given short array to the current
position and increase the position by the number of shorts
written.
Calling this method has the same effect as
put(src, 0, src.length).
Parameters:
src - The source short array This buffer
exception:
BufferOverflowException - If remaining() is less thansrc.length
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | public ShortBuffer put(short[] src, int off, int len)(Code) | | Writes shorts in the given short array, starting from the
specified offset, to the current position and increase the position by
the number of shorts written.
Parameters:
src - The source short array
Parameters:
off - The offset of short array, must be no less than zero and nogreater than src.length
Parameters:
len - The number of shorts to write, must be no lessthan zero and no greater than src.length - off This buffer
exception:
BufferOverflowException - If remaining() is less thanlen
exception:
IndexOutOfBoundsException - If either off or len isinvalid
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | public ShortBuffer put(ShortBuffer src)(Code) | | Writes all the remaining shorts of the src
short buffer to this buffer's current position, and increase both
buffers' position by the number of shorts copied.
Parameters:
src - The source short buffer This buffer
exception:
BufferOverflowException - If src.remaining() is greater than thisbuffer's remaining()
exception:
IllegalArgumentException - If src is this buffer
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | abstract public ShortBuffer put(int index, short s)(Code) | | 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
Parameters:
s - The short to write This buffer
exception:
IndexOutOfBoundsException - If index is invalid
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| slice | | abstract public ShortBuffer slice()(Code) | | 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.
A sliced buffer that shares content with this buffer. |
| toString | | public String toString()(Code) | | Returns a string represents the state of this short buffer.
A string represents the state of this short buffer. |
| wrap | | public static ShortBuffer wrap(short[] array)(Code) | | 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 The created short buffer |
| wrap | | public static ShortBuffer wrap(short[] array, int start, int len)(Code) | | 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
Parameters:
start - The start index, must be no less than zero and no greater thanarray.length
Parameters:
len - The length, must be no less than zero and no greater thanarray.length - start The created short buffer
exception:
IndexOutOfBoundsException - If either start or len isinvalid |
|
|