java.nio
Class HeapShortBuffer

java.lang.Object
  java.nio.Buffer
      java.nio.ShortBuffer
          java.nio.HeapShortBuffer

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

HeapShortBufferR

class HeapShortBuffer

extends ShortBuffer

A read/write HeapShortBuffer.

Field Summary

Fields inherited from class java.nio.ShortBuffer

hb, isReadOnly, offset

Fields inherited from class java.nio.Buffer

address

Constructor Summary

(package private)	HeapShortBuffer(int cap, int lim)
(package private)	HeapShortBuffer(short[] buf, int off, int len)
protected	HeapShortBuffer(short[] buf, int mark, int pos, int lim, int cap, int off)

Method Summary

ShortBuffer	asReadOnlyBuffer() Creates a new, read-only short buffer that shares this buffer's content.
ShortBuffer	compact() Compacts this buffer (optional operation).
ShortBuffer	duplicate() Creates a new short buffer that shares this buffer's content.
short	get() Relative get method.
short	get(int i) Absolute get method.
ShortBuffer	get(short[] dst, int offset, int length) Relative bulk get method.
boolean	isDirect() Tells whether or not this short buffer is direct.
boolean	isReadOnly() Tells whether or not this buffer is read-only.
protected int	ix(int i)
ByteOrder	order() Retrieves this buffer's byte order.
ShortBuffer	put(int i, short x) Absolute put method (optional operation).
ShortBuffer	put(short x) Relative put method (optional operation).
ShortBuffer	put(short[] src, int offset, int length) Relative bulk put method (optional operation).
ShortBuffer	put(ShortBuffer src) Relative bulk put method (optional operation).
ShortBuffer	slice() Creates a new short buffer whose content is a shared subsequence of this buffer's content.

Methods inherited from class java.nio.ShortBuffer

allocate, array, arrayOffset, compareTo, equals, get, hasArray, hashCode, put, toString, wrap, wrap

Methods inherited from class java.nio.Buffer

capacity, checkBounds, checkIndex, checkIndex, clear, flip, hasRemaining, limit, limit, mark, markValue, nextGetIndex, nextGetIndex, nextPutIndex, nextPutIndex, position, position, remaining, reset, rewind

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HeapShortBuffer

HeapShortBuffer(int cap,
                int lim)

HeapShortBuffer

HeapShortBuffer(short[] buf,
                int off,
                int len)

HeapShortBuffer

protected HeapShortBuffer(short[] buf,
                          int mark,
                          int pos,
                          int lim,
                          int cap,
                          int off)

Method Detail

slice

public ShortBuffer slice()

Description copied from class: 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.

Specified by:

slice in class ShortBuffer

Returns:

The new short buffer

duplicate

public ShortBuffer duplicate()

Description copied from class: 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.

Specified by:

duplicate in class ShortBuffer

Returns:

The new short buffer

asReadOnlyBuffer

public ShortBuffer asReadOnlyBuffer()

Description copied from class: 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.

Specified by:

asReadOnlyBuffer in class ShortBuffer

Returns:

The new, read-only short buffer

ix

protected int ix(int i)

get

public short get()

Description copied from class: ShortBuffer

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

Specified by:

get in class ShortBuffer

Returns:

The short at the buffer's current position

get

public short get(int i)

Description copied from class: ShortBuffer

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

Specified by:

get in class ShortBuffer

Parameters:

i - The index from which the short will be read

Returns:

The short at the given index

get

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

Description copied from class: 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

     for (int i = off; i < off + len; i++)
         dst[i] = src.get(); 

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

Overrides:

get in class ShortBuffer

Parameters:

dst - The array into which shorts are to be written

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 shorts to be written to the given array; must be non-negative and no larger than dst.length - offset

Returns:

This buffer

isDirect

public boolean isDirect()

Description copied from class: ShortBuffer

Tells whether or not this short buffer is direct.

Specified by:

isDirect in class ShortBuffer

Returns:

true if, and only if, this buffer is direct

isReadOnly

public boolean isReadOnly()

Description copied from class: Buffer

Tells whether or not this buffer is read-only.

Specified by:

isReadOnly in class Buffer

Returns:

true if, and only if, this buffer is read-only

put

public ShortBuffer put(short x)

Description copied from class: ShortBuffer

Relative put method (optional operation).

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

Specified by:

put in class ShortBuffer

Parameters:

x - The short to be written

Returns:

This buffer

put

public ShortBuffer put(int i,
                       short x)

Description copied from class: ShortBuffer

Absolute put method (optional operation).

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

Specified by:

put in class ShortBuffer

Parameters:

i - The index at which the short will be written

x - The short value to be written

Returns:

This buffer

put

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

Description copied from class: 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

     for (int i = off; i < off + len; i++)
         dst.put(a[i]); 

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

Overrides:

put in class ShortBuffer

Parameters:

src - The array from which shorts are to be read

offset - The offset within the array of the first short to be read; must be non-negative and no larger than array.length

length - The number of shorts to be read from the given array; must be non-negative and no larger than array.length - offset

Returns:

This buffer

put

public ShortBuffer put(ShortBuffer src)

Description copied from class: 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.

Overrides:

put in class ShortBuffer

Parameters:

src - The source buffer from which shorts are to be read; must not be this buffer

Returns:

This buffer

compact

public ShortBuffer compact()

Description copied from class: 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.

Specified by:

compact in class ShortBuffer

Returns:

This buffer

order

public ByteOrder order()

Description copied from class: ShortBuffer

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 native order 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.

Specified by:

order in class ShortBuffer

Returns:

This buffer's byte order