org.bytedeco.javacpp

Class ShortPointer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.ShortPointer

All Implemented Interfaces:

AutoCloseable

public class ShortPointer
extends Pointer

The peer class to native pointers and arrays of short. All operations take into account the position and limit, when appropriate.

Author:

Samuel Audet

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.DeallocatorReference, Pointer.DeallocatorThread, Pointer.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, deallocatorThread, limit, maxBytes, maxPhysicalBytes, maxRetries, position

Constructor Summary

Constructors

Constructor and Description
ShortPointer()
ShortPointer(long size) Allocates a native short array of the given size.
ShortPointer(Pointer p)
ShortPointer(short... array) Allocates enough memory for the array and copies it.
ShortPointer(ShortBuffer buffer) For direct buffers, calls Pointer.Pointer(Buffer), while for buffers backed with an array, allocates enough memory for the array and copies it.

Method Summary

Modifier and Type	Method and Description
private void	allocateArray(long size)
ShortBuffer	asBuffer() Same as Pointer.asByteBuffer(), but can be overridden to return subclasses of Buffer.
ShortPointer	capacity(long capacity) Sets the capacity and returns this.
short	get()
short	get(long i)
ShortPointer	get(short[] array)
ShortPointer	get(short[] array, int offset, int length) Reads a portion of the native array into a Java array.
ShortPointer	limit(long limit) Sets the limit and returns this.
ShortPointer	position(long position) Sets the position and returns this.
ShortPointer	put(long i, short s) Copies the short value to the i-th element of a native array.
ShortPointer	put(short... array)
ShortPointer	put(short s)
ShortPointer	put(short[] array, int offset, int length) Writes a portion of a Java array into the native array.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asByteBuffer, availablePhysicalBytes, calloc, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, init, isNull, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

ShortPointer

public ShortPointer(short... array)

Allocates enough memory for the array and copies it.

Parameters:

array - the array to copy

See Also:

put(short[])

ShortPointer

public ShortPointer(ShortBuffer buffer)

For direct buffers, calls Pointer.Pointer(Buffer), while for buffers backed with an array, allocates enough memory for the array and copies it.

Parameters:

buffer - the Buffer to reference or copy

See Also:

put(short[])

ShortPointer

public ShortPointer(long size)

Allocates a native short array of the given size.

Parameters:

size - the number of short elements to allocate

ShortPointer

public ShortPointer()

See Also:

Pointer.Pointer()

ShortPointer

public ShortPointer(Pointer p)

See Also:

Pointer.Pointer(Pointer)

Method Detail

allocateArray

private void allocateArray(long size)

position

public ShortPointer position(long position)

Description copied from class: Pointer

Sets the position and returns this. That makes the array.position(i) statement sort of equivalent to the array[i] statement in C++.

Overrides:

position in class Pointer

Parameters:

position - the new position

Returns:

this

See Also:

Pointer.position(long)

limit

public ShortPointer limit(long limit)

Description copied from class: Pointer

Sets the limit and returns this. Used to limit the size of an operation on this object.

Overrides:

limit in class Pointer

Parameters:

limit - the new limit

Returns:

this

See Also:

Pointer.limit(long)

capacity

public ShortPointer capacity(long capacity)

Description copied from class: Pointer

Sets the capacity and returns this. Should not be called more than once after allocation.

Overrides:

capacity in class Pointer

Parameters:

capacity - the new capacity

Returns:

this

See Also:

Pointer.capacity(long)

get

public short get()

Returns:

get(0)

get

public short get(long i)

Returns:

the i-th short value of a native array

put

public ShortPointer put(short s)

Returns:

put(0, s)

put

public ShortPointer put(long i,
                        short s)

Copies the short value to the i-th element of a native array.

Parameters:

i - the index into the array

s - the short value to copy

Returns:

this

get

public ShortPointer get(short[] array)

Returns:

get(array, 0, array.length)

put

public ShortPointer put(short... array)

Returns:

put(array, 0, array.length)

get

public ShortPointer get(short[] array,
                        int offset,
                        int length)

Reads a portion of the native array into a Java array.

Parameters:

array - the array to write to

offset - the offset into the array where to start writing

length - the length of data to read and write

Returns:

this

put

public ShortPointer put(short[] array,
                        int offset,
                        int length)

Writes a portion of a Java array into the native array.

Parameters:

array - the array to read from

offset - the offset into the array where to start reading

length - the length of data to read and write

Returns:

this

asBuffer

public final ShortBuffer asBuffer()

Description copied from class: Pointer

Same as Pointer.asByteBuffer(), but can be overridden to return subclasses of Buffer.

Overrides:

asBuffer in class Pointer

Returns:

asByteBuffer().asShortBuffer()

See Also:

BytePointer.asBuffer(), asBuffer(), IntPointer.asBuffer(), LongPointer.asBuffer(), FloatPointer.asBuffer(), DoublePointer.asBuffer(), CharPointer.asBuffer()