Android APIs
public abstract class

ShortBuffer

extends Buffer
implements Comparable<ShortBuffer>
java.lang.Object
   ↳ java.nio.Buffer
     ↳ java.nio.ShortBuffer

Class Overview

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;
  • Use ByteBuffer.asShortBuffer to create a short buffer based on a byte buffer.

Summary

Public Methods
static ShortBuffer allocate(int capacity)
Creates a short buffer based on a newly allocated short array.
final short[] array()
Returns the array that backs this buffer (optional operation).
final 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(int index)
Returns the short at the specified index; the position is not changed.
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.
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.
abstract short get()
Returns the short at the current position and increases the position by 1.
final 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.
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.
final 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.
abstract ShortBuffer put(short s)
Writes the given short to the current position and increases the position by 1.
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 put(int index, short s)
Writes a short to the specified index of this buffer; the position is not changed.
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.
[Expand]
Inherited Methods
From class java.nio.Buffer
From class java.lang.Object
From interface java.lang.Comparable

Public Methods

public static ShortBuffer allocate (int capacity)

Added in API level 1

Creates a short buffer based on a newly allocated short array.

Parameters
capacity int: the capacity of the new buffer.
Returns
ShortBuffer the created short buffer.
Throws
IllegalArgumentException if capacity is less than zero.

public final short[] array ()

Added in API level 1

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
short[] the array

public final int arrayOffset ()

Added in API level 1

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
int the offset

public abstract ShortBuffer asReadOnlyBuffer ()

Added in API level 1

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.

Returns
ShortBuffer a read-only version of this buffer.

public abstract ShortBuffer compact ()

Added in API level 1

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.

Returns
ShortBuffer this buffer.
Throws
ReadOnlyBufferException if no changes may be made to the contents of this buffer.

public int compareTo (ShortBuffer otherBuffer)

Added in API level 1

Compare the remaining shorts of this buffer to another short buffer's remaining shorts.

Parameters
otherBuffer ShortBuffer: another short buffer.
Returns
int a negative value if this is less than otherBuffer; 0 if this equals to otherBuffer; a positive value if this is greater than otherBuffer.
Throws
ClassCastException if otherBuffer is not a short buffer.

public abstract ShortBuffer duplicate ()

Added in API level 1

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.

Returns
ShortBuffer

public boolean equals (Object other)

Added in API level 1

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.

Parameters
other Object: the object to compare with this short buffer.
Returns
boolean true if this short buffer is equal to other, false otherwise.

public abstract short get (int index)

Added in API level 1

Returns the short at the specified index; the position is not changed.

Parameters
index int: the index, must not be negative and less than limit.
Returns
short a short at the specified index.
Throws
IndexOutOfBoundsException if index is invalid.

public ShortBuffer get (short[] dst, int dstOffset, int shortCount)

Added in API level 1

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.

Parameters
dst short: the target short array.
dstOffset int: the offset of the short array, must not be negative and not greater than dst.length.
shortCount int: the number of shorts to read, must be no less than zero and not greater than dst.length - dstOffset.
Returns
ShortBuffer this buffer.
Throws
IndexOutOfBoundsException if either dstOffset or shortCount is invalid.
BufferUnderflowException if shortCount is greater than remaining().

public ShortBuffer get (short[] dst)

Added in API level 1

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).

Parameters
dst short: the destination short array.
Returns
ShortBuffer this buffer.
Throws
BufferUnderflowException if dst.length is greater than remaining().

public abstract short get ()

Added in API level 1

Returns the short at the current position and increases the position by 1.

Returns
short the short at the current position.
Throws
BufferUnderflowException if the position is equal or greater than limit.

public final boolean hasArray ()

Added in API level 1

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.

Returns
boolean

public int hashCode ()

Added in API level 1

Calculates this buffer's hash code from the remaining chars. The position, limit, capacity and mark don't affect the hash code.

Returns
int the hash code calculated from the remaining shorts.

public abstract boolean isDirect ()

Added in API level 1

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.

Returns
boolean true if this buffer is direct, false otherwise.

public abstract ByteOrder order ()

Added in API level 1

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.

Returns
ByteOrder the byte order used by this buffer when converting shorts from/to bytes.

public ShortBuffer put (short[] src, int srcOffset, int shortCount)

Added in API level 1

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.

Parameters
src short: the source short array.
srcOffset int: the offset of short array, must not be negative and not greater than src.length.
shortCount int: the number of shorts to write, must be no less than zero and not greater than src.length - srcOffset.
Returns
ShortBuffer this buffer.
Throws
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 final ShortBuffer put (short[] src)

Added in API level 1

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).

Parameters
src short: the source short array.
Returns
ShortBuffer this buffer.
Throws
BufferOverflowException if remaining() is less than src.length.
ReadOnlyBufferException if no changes may be made to the contents of this buffer.

public abstract ShortBuffer put (short s)

Added in API level 1

Writes the given short to the current position and increases the position by 1.

Parameters
s short: the short to write.
Returns
ShortBuffer this buffer.
Throws
BufferOverflowException if position is equal or greater than limit.
ReadOnlyBufferException if no changes may be made to the contents of this buffer.

public ShortBuffer put (ShortBuffer src)

Added in API level 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.

Parameters
src ShortBuffer: the source short buffer.
Returns
ShortBuffer this buffer.
Throws
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)

Added in API level 1

Writes a short to the specified index of this buffer; the position is not changed.

Parameters
index int: the index, must not be negative and less than the limit.
s short: the short to write.
Returns
ShortBuffer this buffer.
Throws
IndexOutOfBoundsException if index is invalid.
ReadOnlyBufferException if no changes may be made to the contents of this buffer.

public abstract ShortBuffer slice ()

Added in API level 1

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.

Returns
ShortBuffer

public static ShortBuffer wrap (short[] array)

Added in API level 1

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 short: the short array which the new buffer will be based on.
Returns
ShortBuffer the created short buffer.

public static ShortBuffer wrap (short[] array, int start, int shortCount)

Added in API level 1

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.

Parameters
array short: the short array which the new buffer will be based on.
start int: the start index, must not be negative and not greater than array.length.
shortCount int: the length, must not be negative and not greater than array.length - start.
Returns
ShortBuffer the created short buffer.
Throws
IndexOutOfBoundsException if either start or shortCount is invalid.