Added in API level 1

ShortBuffer

abstract class ShortBuffer : Buffer, Comparable<ShortBuffer!>

kotlin.Any
↳	java.nio.Buffer
	↳	java.nio.ShortBuffer

A short buffer.

This class defines four categories of operations upon short buffers:

Absolute and relative get and put methods that read and write single shorts;
Relative bulk get methods that transfer contiguous sequences of shorts from this buffer into an array; and
Relative bulk put methods that transfer contiguous sequences of shorts from a short array or some other short buffer into this buffer; and
Methods for compacting, , and slicing a short buffer.

Short buffers can be created either by allocation, which allocates space for the buffer's content, by wrapping an existing short array into a buffer, or by creating a view of an existing byte buffer.

Like a byte buffer, a short buffer is either direct or non-direct. A short buffer created via the wrap methods of this class will be non-direct. A short buffer created as a view of a byte buffer will be direct if, and only if, the byte buffer itself is direct. Whether or not a short buffer is direct may be determined by invoking the method.

Methods in this class that do not otherwise have a value to return are specified to return the buffer upon which they are invoked. This allows method invocations to be chained.

Summary

Public methods
open static ShortBuffer!	`allocate(capacity: Int)` Allocates a new short buffer.
ShortArray!	`array()` Returns the short array that backs this buffer (optional operation).
Int	`arrayOffset()` Returns the offset within this buffer's backing array of the first element of the buffer (optional operation).
abstract ShortBuffer!	`asReadOnlyBuffer()` Creates a new, read-only short buffer that shares this buffer's content.
open Buffer!	`clear()`
abstract ShortBuffer!	`compact()` Compacts this buffer (optional operation).
open Int	`compareTo(other: ShortBuffer!)` Compares this buffer to another.
abstract ShortBuffer!	`duplicate()` Creates a new short buffer that shares this buffer's content.
open Boolean	`equals(other: Any?)` Tells whether or not this buffer is equal to another object.
open Buffer!	`flip()`
abstract Short	`get()` Relative get method.
abstract Short	`get(index: Int)` Absolute get method.
open ShortBuffer!	`get(dst: ShortArray!, offset: Int, length: Int)` Relative bulk get method.
open ShortBuffer!	`get(dst: ShortArray!)` Relative bulk get method.
Boolean	`hasArray()` Tells whether or not this buffer is backed by an accessible short array.
open Int	`hashCode()` Returns the current hash code of this buffer.
abstract Boolean	`isDirect()` Tells whether or not this short buffer is direct.
open Buffer!	`limit(newLimit: Int)`
open Buffer!	`mark()`
abstract ByteOrder!	`order()` Retrieves this buffer's byte order.
open Buffer!	`position(newPosition: Int)`
abstract ShortBuffer!	`put(s: Short)` Relative put method (optional operation).
abstract ShortBuffer!	`put(index: Int, s: Short)` Absolute put method (optional operation).
open ShortBuffer!	`put(src: ShortBuffer!)` Relative bulk put method (optional operation).
open ShortBuffer!	`put(src: ShortArray!, offset: Int, length: Int)` Relative bulk put method (optional operation).
ShortBuffer!	`put(src: ShortArray!)` Relative bulk put method (optional operation).
open Buffer!	`reset()`
open Buffer!	`rewind()`
abstract ShortBuffer!	`slice()` Creates a new short buffer whose content is a shared subsequence of this buffer's content.
open String	`toString()` Returns a string summarizing the state of this buffer.
open static ShortBuffer!	`wrap(array: ShortArray!, offset: Int, length: Int)` Wraps a short array into a buffer.
open static ShortBuffer!	`wrap(array: ShortArray!)` Wraps a short array into a buffer.

Inherited functions

From class Buffer

`Int`	`capacity()` Returns this buffer's capacity.
`Boolean`	`hasRemaining()` Tells whether there are any elements between the current position and the limit.
`Boolean`	`isReadOnly()` Tells whether or not this buffer is read-only.
`Int`	`limit()` Returns this buffer's limit.
`Int`	`position()` Returns this buffer's position.
`Int`	`remaining()` Returns the number of elements between the current position and the limit.

Public methods

allocate

Added in API level 1

open static fun allocate(capacity: Int): ShortBuffer!

Allocates a new short buffer.

The new buffer's position will be zero, its limit will be its capacity, its mark will be undefined, and each of its elements will be initialized to zero. It will have a backing array, and its array offset will be zero.

Parameters
`capacity`	Int: The new buffer's capacity, in shorts

Return
`ShortBuffer!`	The new short buffer

Exceptions
`java.lang.IllegalArgumentException`	If the capacity is a negative integer

array

Added in API level 1

fun array(): ShortArray!

Returns the short array that backs this buffer (optional operation).

Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa.

Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.

Return
`ShortArray!`	The array that backs this buffer

Exceptions
`java.nio.ReadOnlyBufferException`	If this buffer is backed by an array but is read-only
`java.lang.UnsupportedOperationException`	If this buffer is not backed by an accessible array

arrayOffset

Added in API level 1

fun arrayOffset(): Int

Returns the offset within this buffer's backing array of the first element of the buffer (optional operation).

If this buffer is backed by an array then buffer position p corresponds to array index p + arrayOffset().

Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.

Return
`Int`	The offset within this buffer's array of the first element of the buffer

Exceptions
`java.nio.ReadOnlyBufferException`	If this buffer is backed by an array but is read-only
`java.lang.UnsupportedOperationException`	If this buffer is not backed by an accessible array

asReadOnlyBuffer

Added in API level 1

abstract fun asReadOnlyBuffer(): ShortBuffer!

Creates a new, read-only short buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer.

If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate method.

Return
`ShortBuffer!`	The new, read-only short buffer

clear

Added in API level 1

open fun clear(): Buffer!

Return
`Buffer!`	This buffer

compact

Added in API level 1

abstract fun compact(): ShortBuffer!

Compacts this buffer (optional operation).

The shorts between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the short at index p = position() is copied to index zero, the short at index p + 1 is copied to index one, and so forth until the short at index limit() - 1 is copied to index n = limit() - 1 - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.

The buffer's position is set to the number of shorts copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.

Return
`ShortBuffer!`	This buffer

Exceptions
`java.nio.ReadOnlyBufferException`	If this buffer is read-only

compareTo

Added in API level 1

open fun compareTo(other: ShortBuffer!): Int

Compares this buffer to another.

Two short buffers are compared by comparing their sequences of remaining elements lexicographically, without regard to the starting position of each sequence within its corresponding buffer. Pairs of short elements are compared as if by invoking Short#compare(short,short).

A short buffer is not comparable to any other type of object.

Parameters
`o`	the object to be compared.

Return
`Int`	A negative integer, zero, or a positive integer as this buffer is less than, equal to, or greater than the given buffer

Exceptions
`java.lang.NullPointerException`	if the specified object is null
`java.lang.ClassCastException`	if the specified object's type prevents it from being compared to this object.

duplicate

Added in API level 1

abstract fun duplicate(): ShortBuffer!

Creates a new short buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Return
`ShortBuffer!`	The new short buffer

equals

Added in API level 1

open fun equals(other: Any?): Boolean

Tells whether or not this buffer is equal to another object.

Two short buffers are equal if, and only if,

They have the same element type,
They have the same number of remaining elements, and
The two sequences of remaining elements, considered independently of their starting positions, are pointwise equal.

A short buffer is not equal to any other type of object.

Parameters
`obj`	the reference object with which to compare.
`ob`	The object to which this buffer is to be compared

Return
`Boolean`	true if, and only if, this buffer is equal to the given object

flip

Added in API level 1

open fun flip(): Buffer!

Return
`Buffer!`	This buffer

get

Added in API level 1

abstract fun get(): Short

Relative get method. Reads the short at this buffer's current position, and then increments the position.

Return
`Short`	The short at the buffer's current position

Exceptions
`java.nio.BufferUnderflowException`	If the buffer's current position is not smaller than its limit

get

Added in API level 1

abstract fun get(index: Int): Short

Absolute get method. Reads the short at the given index.

Parameters
`index`	Int: The index from which the short will be read

Return
`Short`	The short at the given index

Exceptions
`java.lang.IndexOutOfBoundsException`	If index is negative or not smaller than the buffer's limit

get

Added in API level 1

open fun get(
    dst: ShortArray!, 
    offset: Int, 
    length: Int
): ShortBuffer!

Relative bulk get method.

This method transfers shorts from this buffer into the given destination array. If there are fewer shorts remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no shorts are transferred and a BufferUnderflowException is thrown.

Otherwise, this method copies length shorts from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form src.get(dst, off, len) has exactly the same effect as the loop

<code>for (int i = off; i &lt; off + len; i++)
          dst[i] = src.get();
  </code>

except that it first checks that there are sufficient shorts in this buffer and it is potentially much more efficient.

Parameters
`dst`	ShortArray!: The array into which shorts are to be written
`offset`	Int: The offset within the array of the first short to be written; must be non-negative and no larger than dst.length
`length`	Int: The maximum number of shorts to be written to the given array; must be non-negative and no larger than dst.length - offset

Return
`ShortBuffer!`	This buffer

Exceptions
`java.nio.BufferUnderflowException`	If there are fewer than length shorts remaining in this buffer
`java.lang.IndexOutOfBoundsException`	If the preconditions on the offset and length parameters do not hold

get

Added in API level 1

open fun get(dst: ShortArray!): ShortBuffer!

Relative bulk get method.

This method transfers shorts from this buffer into the given destination array. An invocation of this method of the form src.get(a) behaves in exactly the same way as the invocation

src.get(a, 0, a.length)

Parameters
`dst`	ShortArray!: The destination array

Return
`ShortBuffer!`	This buffer

Exceptions
`java.nio.BufferUnderflowException`	If there are fewer than length shorts remaining in this buffer

hasArray

Added in API level 1

fun hasArray(): Boolean

Tells whether or not this buffer is backed by an accessible short array.

If this method returns true then the array and arrayOffset methods may safely be invoked.

Return
`Boolean`	true if, and only if, this buffer is backed by an array and is not read-only

hashCode

Added in API level 1

open fun hashCode(): Int

Returns the current hash code of this buffer.

The hash code of a short buffer depends only upon its remaining elements; that is, upon the elements from position() up to, and including, the element at limit() - 1.

Because buffer hash codes are content-dependent, it is inadvisable to use buffers as keys in hash maps or similar data structures unless it is known that their contents will not change.

Return
`Int`	The current hash code of this buffer

isDirect

Added in API level 1

abstract fun isDirect(): Boolean

Tells whether or not this short buffer is direct.

Return
`Boolean`	true if, and only if, this buffer is direct

limit

Added in API level 1

open fun limit(newLimit: Int): Buffer!

Parameters
`newLimit`	Int: The new limit value; must be non-negative and no larger than this buffer's capacity

Return
`Buffer!`	This buffer

Exceptions
`java.lang.IllegalArgumentException`	If the preconditions on newLimit do not hold

mark

Added in API level 1

open fun mark(): Buffer!

Return
`Buffer!`	This buffer

order

Added in API level 1

abstract fun order(): ByteOrder!

Retrieves this buffer's byte order.

The byte order of a short buffer created by allocation or by wrapping an existing short array is the ByteOrder#nativeOrder of the underlying hardware. The byte order of a short buffer created as a view of a byte buffer is that of the byte buffer at the moment that the view is created.

Return
`ByteOrder!`	This buffer's byte order

position

Added in API level 1

open fun position(newPosition: Int): Buffer!

Parameters
`newPosition`	Int: The new position value; must be non-negative and no larger than the current limit

Return
`Buffer!`	This buffer

Exceptions
`java.lang.IllegalArgumentException`	If the preconditions on newPosition do not hold

put

Added in API level 1

abstract fun put(s: Short): ShortBuffer!

Relative put method (optional operation).

Writes the given short into this buffer at the current position, and then increments the position.

Parameters
`s`	Short: The short to be written

Return
`ShortBuffer!`	This buffer

Exceptions
`java.nio.BufferOverflowException`	If this buffer's current position is not smaller than its limit
`java.nio.ReadOnlyBufferException`	If this buffer is read-only

put

Added in API level 1

abstract fun put(
    index: Int, 
    s: Short
): ShortBuffer!

Absolute put method (optional operation).

Writes the given short into this buffer at the given index.

Parameters
`index`	Int: The index at which the short will be written
`s`	Short: The short value to be written

Return
`ShortBuffer!`	This buffer

Exceptions
`java.lang.IndexOutOfBoundsException`	If index is negative or not smaller than the buffer's limit
`java.nio.ReadOnlyBufferException`	If this buffer is read-only

put

Added in API level 1

open fun put(src: ShortBuffer!): ShortBuffer!

Relative bulk put method (optional operation).

This method transfers the shorts remaining in the given source buffer into this buffer. If there are more shorts remaining in the source buffer than in this buffer, that is, if src.remaining() > remaining(), then no shorts are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies n = src.remaining() shorts from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.

In other words, an invocation of this method of the form dst.put(src) has exactly the same effect as the loop

while (src.hasRemaining())
          dst.put(src.get());

except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.

Parameters
`src`	ShortBuffer!: The source buffer from which shorts are to be read; must not be this buffer

Return
`ShortBuffer!`	This buffer

Exceptions
`java.nio.BufferOverflowException`	If there is insufficient space in this buffer for the remaining shorts in the source buffer
`java.lang.IllegalArgumentException`	If the source buffer is this buffer
`java.nio.ReadOnlyBufferException`	If this buffer is read-only

put

Added in API level 1

open fun put(
    src: ShortArray!, 
    offset: Int, 
    length: Int
): ShortBuffer!

Relative bulk put method (optional operation).

This method transfers shorts into this buffer from the given source array. If there are more shorts to be copied from the array than remain in this buffer, that is, if length > remaining(), then no shorts are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies length shorts from the given array into this buffer, starting at the given offset in the array and at the current position of this buffer. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form dst.put(src, off, len) has exactly the same effect as the loop

<code>for (int i = off; i &lt; off + len; i++)
          dst.put(a[i]);
  </code>

except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.

Parameters
`src`	ShortArray!: The array from which shorts are to be read
`offset`	Int: The offset within the array of the first short to be read; must be non-negative and no larger than array.length
`length`	Int: The number of shorts to be read from the given array; must be non-negative and no larger than array.length - offset

Return
`ShortBuffer!`	This buffer

Exceptions
`java.nio.BufferOverflowException`	If there is insufficient space in this buffer
`java.lang.IndexOutOfBoundsException`	If the preconditions on the offset and length parameters do not hold
`java.nio.ReadOnlyBufferException`	If this buffer is read-only

put

Added in API level 1

fun put(src: ShortArray!): ShortBuffer!

Relative bulk put method (optional operation).

This method transfers the entire content of the given source short array into this buffer. An invocation of this method of the form dst.put(a) behaves in exactly the same way as the invocation

dst.put(a, 0, a.length)

Parameters
`src`	ShortArray!: The source array

Return
`ShortBuffer!`	This buffer

Exceptions
`java.nio.BufferOverflowException`	If there is insufficient space in this buffer
`java.nio.ReadOnlyBufferException`	If this buffer is read-only

reset

Added in API level 1

open fun reset(): Buffer!

Return
`Buffer!`	This buffer

Exceptions
`java.nio.InvalidMarkException`	If the mark has not been set

rewind

Added in API level 1

open fun rewind(): Buffer!

Return
`Buffer!`	This buffer

slice

Added in API level 1

abstract fun slice(): ShortBuffer!

Creates a new short buffer whose content is a shared subsequence of this buffer's content.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of shorts remaining in this buffer, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Return
`ShortBuffer!`	The new short buffer

toString

Added in API level 1

open fun toString(): String

Returns a string summarizing the state of this buffer.

Return
`String`	A summary string

wrap

Added in API level 1

open static fun wrap(
    array: ShortArray!, 
    offset: Int, 
    length: Int
): ShortBuffer!

Wraps a short array into a buffer.

The new buffer will be backed by the given short array; that is, modifications to the buffer will cause the array to be modified and vice versa. The new buffer's capacity will be array.length, its position will be offset, its limit will be offset + length, and its mark will be undefined. Its backing array will be the given array, and its array offset will be zero.

Parameters
`array`	ShortArray!: The array that will back the new buffer
`offset`	Int: The offset of the subarray to be used; must be non-negative and no larger than array.length. The new buffer's position will be set to this value.
`length`	Int: The length of the subarray to be used; must be non-negative and no larger than array.length - offset. The new buffer's limit will be set to offset + length.

Return
`ShortBuffer!`	The new short buffer

Exceptions
`java.lang.IndexOutOfBoundsException`	If the preconditions on the offset and length parameters do not hold

wrap

Added in API level 1

open static fun wrap(array: ShortArray!): ShortBuffer!

Wraps a short array into a buffer.

The new buffer will be backed by the given short array; that is, modifications to the buffer will cause the array to be modified and vice versa. The new buffer's capacity and limit will be array.length, its position will be zero, and its mark will be undefined. Its backing array will be the given array, and its array offset> will be zero.

Parameters
`array`	ShortArray!: The array that will back this buffer

Return
`ShortBuffer!`	The new short buffer