APIdia Launch Partner
Top Description Fields Constructors Methods
java.nio

pack-priv sealed Class HeapShortBuffer

extends ShortBuffer
permits HeapShortBufferR
Class Inheritance
Known Direct Subclasses
java.nio.HeapShortBufferR
Imports
java.lang.foreign.MemorySegment, jdk.internal.foreign.AbstractMemorySegmentImpl, .MemorySessionImpl, .SegmentFactories, jdk.internal.vm.annotation.ForceInline, java.util.Objects

A read/write HeapShortBuffer.

Field Summary

Modifier and TypeField and Description
private static final long
private static final long
Inherited from java.nio.ShortBuffer:
hbisReadOnlyoffset

Constructor Summary

AccessConstructor and Description
pack-priv
HeapShortBuffer(int cap, int lim, MemorySegment segment)

pack-priv
HeapShortBuffer(short[] buf, int off, int len, MemorySegment segment)

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

Method Summary

Modifier and TypeMethod and Description
public ShortBuffer
asReadOnlyBuffer()

Implements abstract java.nio.ShortBuffer.asReadOnlyBuffer.

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

public ShortBuffer
compact()

Implements abstract java.nio.ShortBuffer.compact.

Compacts this buffer  (optional operation).

public ShortBuffer
duplicate()

Implements abstract java.nio.ShortBuffer.duplicate.

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

public short
get()

Implements abstract java.nio.ShortBuffer.get.

Relative get method.

public short
get(int i)

Implements abstract java.nio.ShortBuffer.get.

Absolute get method.

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

Overrides java.nio.ShortBuffer.get.

Relative bulk get method.

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

Overrides java.nio.ShortBuffer.get.

Absolute bulk get method.

public boolean
isDirect()

Implements abstract java.nio.ShortBuffer.isDirect.

Tells whether or not this short buffer is direct.

public boolean
isReadOnly()

Implements abstract java.nio.Buffer.isReadOnly.

Tells whether or not this buffer is read-only.

protected int
ix(int i)

public ByteOrder
order()

Implements abstract java.nio.ShortBuffer.order.

Retrieves this buffer's byte order.

public ShortBuffer
put(short x)

Implements abstract java.nio.ShortBuffer.put.

Relative put method  (optional operation).

public ShortBuffer
put(int i, short x)

Implements abstract java.nio.ShortBuffer.put.

Absolute put method  (optional operation).

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

Overrides java.nio.ShortBuffer.put.

Relative bulk put method  (optional operation).

public ShortBuffer
put(ShortBuffer src)

Overrides java.nio.ShortBuffer.put.

Relative bulk put method  (optional operation).

public ShortBuffer
put(int index, ShortBuffer src, int offset, int length)

Overrides java.nio.ShortBuffer.put.

Absolute bulk put method  (optional operation).

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

Overrides java.nio.ShortBuffer.put.

Absolute bulk put method  (optional operation).

public ShortBuffer
slice()

Implements abstract java.nio.ShortBuffer.slice.

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

public ShortBuffer
slice(int index, int length)

Implements abstract java.nio.ShortBuffer.slice.

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

Inherited from java.nio.ShortBuffer:
allocatearrayarrayOffsetbaseclearcompareToequalsflipgetgetgetArrayhasArrayhashCodeheapSegmentlimitmarkmismatchpositionputputputArrayputBufferresetrewindscaleShiftstoStringwrapwrap

Field Detail

ARRAY_BASE_OFFSETback to summary
private static final long ARRAY_BASE_OFFSET

Hides java.nio.ShortBuffer.ARRAY_BASE_OFFSET.

ARRAY_INDEX_SCALEback to summary
private static final long ARRAY_INDEX_SCALE

Constructor Detail

HeapShortBufferback to summary
pack-priv HeapShortBuffer(int cap, int lim, MemorySegment segment)
HeapShortBufferback to summary
pack-priv HeapShortBuffer(short[] buf, int off, int len, MemorySegment segment)
HeapShortBufferback to summary
protected HeapShortBuffer(short[] buf, int mark, int pos, int lim, int cap, int off, MemorySegment segment)

Method Detail

asReadOnlyBufferback to summary
public ShortBuffer asReadOnlyBuffer()

Implements abstract java.nio.ShortBuffer.asReadOnlyBuffer.

Doc from java.nio.ShortBuffer.asReadOnlyBuffer.

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, mark values, and byte order 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.

compactback to summary
public ShortBuffer compact()

Implements abstract java.nio.ShortBuffer.compact.

Doc from java.nio.ShortBuffer.compact.

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.

duplicateback to summary
public ShortBuffer duplicate()

Implements abstract java.nio.ShortBuffer.duplicate.

Doc from java.nio.ShortBuffer.duplicate.

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, mark values, and byte order 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.

getback to summary
public short get()

Implements abstract java.nio.ShortBuffer.get.

Doc from java.nio.ShortBuffer.get.

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

getback to summary
public short get(int i)

Implements abstract java.nio.ShortBuffer.get.

Doc from java.nio.ShortBuffer.get.

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

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

Overrides java.nio.ShortBuffer.get.

Doc from java.nio.ShortBuffer.get.

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();
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.
getback to summary
public ShortBuffer get(int index, short[] dst, int offset, int length)

Overrides java.nio.ShortBuffer.get.

Doc from java.nio.ShortBuffer.get.

Absolute bulk get method.

This method transfers length shorts from this buffer into the given array, starting at the given index in this buffer and at the given offset in the array. The position of this buffer is unchanged.

An invocation of this method of the form src.get(index, dst, offset, length) has exactly the same effect as the following loop except that it first checks the consistency of the supplied parameters and it is potentially much more efficient:

for (int i = offset, j = index; i < offset + length; i++, j++) dst[i] = src.get(j);
for (int i = offset, j = index; i < offset + length; i++, j++)
    dst[i] = src.get(j);
isDirectback to summary
public boolean isDirect()

Implements abstract java.nio.ShortBuffer.isDirect.

Doc from java.nio.ShortBuffer.isDirect.

Tells whether or not this short buffer is direct.

isReadOnlyback to summary
public boolean isReadOnly()

Implements abstract java.nio.Buffer.isReadOnly.

Doc from java.nio.Buffer.isReadOnly.

Tells whether or not this buffer is read-only.

ixback to summary
protected int ix(int i)
orderback to summary
public ByteOrder order()

Implements abstract java.nio.ShortBuffer.order.

Doc from java.nio.ShortBuffer.order.

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.

putback to summary
public ShortBuffer put(short x)

Implements abstract java.nio.ShortBuffer.put.

Doc from java.nio.ShortBuffer.put.

Relative put method  (optional operation).

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

putback to summary
public ShortBuffer put(int i, short x)

Implements abstract java.nio.ShortBuffer.put.

Doc from java.nio.ShortBuffer.put.

Absolute put method  (optional operation).

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

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

Overrides java.nio.ShortBuffer.put.

Doc from java.nio.ShortBuffer.put.

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(src[i]);
for (int i = off; i < off + len; i++)
    dst.put(src[i]);
except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
putback to summary
public ShortBuffer put(ShortBuffer src)

Overrides java.nio.ShortBuffer.put.

Doc from java.nio.ShortBuffer.put.

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());
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. If this buffer and the source buffer share the same backing array or memory, then the result will be as if the source elements were first copied to an intermediate location before being written into this buffer.
putback to summary
public ShortBuffer put(int index, ShortBuffer src, int offset, int length)

Overrides java.nio.ShortBuffer.put.

Doc from java.nio.ShortBuffer.put.

Absolute bulk put method  (optional operation).

This method transfers length shorts into this buffer from the given source buffer, starting at the given offset in the source buffer and the given index in this buffer. The positions of both buffers are unchanged.

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

for (int i = offset, j = index; i < offset + length; i++, j++) dst.put(j, src.get(i));
for (int i = offset, j = index; i < offset + length; i++, j++)
    dst.put(j, src.get(i));
except that it first checks the consistency of the supplied parameters and it is potentially much more efficient. If this buffer and the source buffer share the same backing array or memory, then the result will be as if the source elements were first copied to an intermediate location before being written into this buffer.
putback to summary
public ShortBuffer put(int index, short[] src, int offset, int length)

Overrides java.nio.ShortBuffer.put.

Doc from java.nio.ShortBuffer.put.

Absolute bulk put method  (optional operation).

This method transfers length shorts from the given array, starting at the given offset in the array and at the given index in this buffer. The position of this buffer is unchanged.

An invocation of this method of the form dst.put(index, src, offset, length) has exactly the same effect as the following loop except that it first checks the consistency of the supplied parameters and it is potentially much more efficient:

for (int i = offset, j = index; i < offset + length; i++, j++) dst.put(j, src[i]);
for (int i = offset, j = index; i < offset + length; i++, j++)
    dst.put(j, src[i]);
sliceback to summary
public ShortBuffer slice()

Implements abstract java.nio.ShortBuffer.slice.

Doc from java.nio.ShortBuffer.slice.

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, its mark will be undefined, and its byte order will be identical to that 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.

sliceback to summary
public ShortBuffer slice(int index, int length)

Implements abstract java.nio.ShortBuffer.slice.

Doc from java.nio.ShortBuffer.slice.

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 position index in this buffer, and will contain length elements. 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 length, its mark will be undefined, and its byte order will be identical to that 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.

Annotations
@Override