java.nio

Class ShortBuffer

public abstract class ShortBuffer extends Buffer implements Comparable<ShortBuffer>

Since: 1.4

Method Summary
static ShortBuffer	allocate(int capacity) Allocates a new `ShortBuffer` object with a given capacity.
short[]	array() Returns the `short` array that backs this buffer.
int	arrayOffset() Returns the offset within this buffer's backing array of the first element.
abstract ShortBuffer	asReadOnlyBuffer() Creates a new read-only `ShortBuffer` that shares this buffer's content.
abstract ShortBuffer	compact() Compacts this buffer.
int	compareTo(ShortBuffer other) Compares two `ShortBuffer` objects.
abstract ShortBuffer	duplicate() Creates a new `ShortBuffer` that shares this buffer's content.
boolean	equals(Object obj) Checks if this buffer is equal to obj.
ShortBuffer	get(short[] dst, int offset, int length) This method transfers `short`s from this buffer into the given destination array.
ShortBuffer	get(short[] dst) This method transfers `short`s from this buffer into the given destination array.
abstract short	get() Reads the `short` at this buffer's current position, and then increments the position.
abstract short	get(int index) Absolute get method.
boolean	hasArray() Tells whether ot not this buffer is backed by an accessible `short` array.
int	hashCode() Calculates a hash code for this buffer.
abstract boolean	isDirect() Tells wether or not this buffer is direct.
abstract ByteOrder	order() Returns the byte order of this buffer.
ShortBuffer	put(ShortBuffer src) Writes the content of the the `ShortBUFFER` src into the buffer.
ShortBuffer	put(short[] src, int offset, int length) Writes the content of the the `short array` src into the buffer.
ShortBuffer	put(short[] src) Writes the content of the the `short array` src into the buffer.
abstract ShortBuffer	put(short b) Writes the `short` at this buffer's current position, and then increments the position.
abstract ShortBuffer	put(int index, short b) Absolute put method.
abstract ShortBuffer	slice() Creates a new `ShortBuffer` whose content is a shared subsequence of this buffer's content.
static ShortBuffer	wrap(short[] array, int offset, int length) Wraps a `short` array into a `ShortBuffer` object.
static ShortBuffer	wrap(short[] array) Wraps a `short` array into a `ShortBuffer` object.

Method Detail

allocate

public static ShortBuffer allocate(int capacity)

Allocates a new ShortBuffer object with a given capacity.

array

public final short[] array()

Returns the short array that backs this buffer.

Throws: ReadOnlyBufferException If this buffer is read-only. UnsupportedOperationException If this buffer is not backed by an accessible array.

arrayOffset

public final int arrayOffset()

Returns the offset within this buffer's backing array of the first element.

Throws: ReadOnlyBufferException If this buffer is read-only. UnsupportedOperationException If this buffer is not backed by an accessible array.

asReadOnlyBuffer

public abstract ShortBuffer asReadOnlyBuffer()

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

compact

public abstract ShortBuffer compact()

Compacts this buffer.

Throws: ReadOnlyBufferException If this buffer is read-only.

compareTo

public int compareTo(ShortBuffer other)

Compares two ShortBuffer objects.

Throws: ClassCastException If obj is not an object derived from ShortBuffer.

duplicate

public abstract ShortBuffer duplicate()

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

equals

public boolean equals(Object obj)

Checks if this buffer is equal to obj.

get

public ShortBuffer get(short[] dst, int offset, int length)

This method transfers shorts from this buffer into the given destination array. Before the transfer, it checks if there are fewer than length shorts remaining in this buffer.

Parameters: dst The destination array offset The offset within the array of the first short to be written; must be non-negative and no larger than dst.length. length The maximum number of bytes to be written to the given array; must be non-negative and no larger than dst.length - offset.

Throws: BufferUnderflowException If there are fewer than length shorts remaining in this buffer. IndexOutOfBoundsException If the preconditions on the offset and length parameters do not hold.

get

public ShortBuffer get(short[] dst)

This method transfers shorts from this buffer into the given destination array.

Parameters: dst The byte array to write into.

Throws: BufferUnderflowException If there are fewer than dst.length shorts remaining in this buffer.

get

public abstract short get()

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

Throws: BufferUnderflowException If there are no remaining shorts in this buffer.

get

public abstract short get(int index)

Absolute get method.

Throws: IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit.

hasArray

public final boolean hasArray()

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

hashCode

public int hashCode()

Calculates a hash code for this buffer. This is done with int arithmetic, where ** represents exponentiation, by this formula:

s[position()] + 31 + (s[position()+1] + 30)*31**1 + ... +
 (s[limit()-1]+30)*31**(limit()-1)

. Where s is the buffer data. Note that the hashcode is dependent on buffer content, and therefore is not useful if the buffer content may change.

Returns: the hash code

isDirect

public abstract boolean isDirect()

Tells wether or not this buffer is direct.

order

public abstract ByteOrder order()

Returns the byte order of this buffer.

put

public ShortBuffer put(ShortBuffer src)

Writes the content of the the ShortBUFFER src into the buffer. Before the transfer, it checks if there is fewer than src.remaining() space remaining in this buffer.

Parameters: src The source data.

Throws: BufferOverflowException If there is insufficient space in this buffer for the remaining shorts in the source buffer. IllegalArgumentException If the source buffer is this buffer. ReadOnlyBufferException If this buffer is read-only.

put

public ShortBuffer put(short[] src, int offset, int length)

Writes the content of the the short array src into the buffer. Before the transfer, it checks if there is fewer than length space remaining in this buffer.

Parameters: src The array to copy into the buffer. offset The offset within the array of the first byte to be read; must be non-negative and no larger than src.length. length The number of bytes to be read from the given array; must be non-negative and no larger than src.length - offset.

Throws: BufferOverflowException If there is insufficient space in this buffer for the remaining shorts in the source array. IndexOutOfBoundsException If the preconditions on the offset and length parameters do not hold ReadOnlyBufferException If this buffer is read-only.

put

public final ShortBuffer put(short[] src)

Writes the content of the the short array src into the buffer.

Parameters: src The array to copy into the buffer.

Throws: BufferOverflowException If there is insufficient space in this buffer for the remaining shorts in the source array. ReadOnlyBufferException If this buffer is read-only.

put

public abstract ShortBuffer put(short b)

Writes the short at this buffer's current position, and then increments the position.

Throws: BufferOverflowException If there no remaining shorts in this buffer. ReadOnlyBufferException If this buffer is read-only.

put

public abstract ShortBuffer put(int index, short b)

Absolute put method.

Throws: IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit. ReadOnlyBufferException If this buffer is read-only.

slice

public abstract ShortBuffer slice()

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

wrap

public static final ShortBuffer wrap(short[] array, int offset, int length)

Wraps a short array into a ShortBuffer object.

Throws: IndexOutOfBoundsException If the preconditions on the offset and length parameters do not hold

wrap

public static final ShortBuffer wrap(short[] array)

Wraps a short array into a ShortBuffer object.