Package org.bytedeco.javacpp
Class ShortPointer
- java.lang.Object
-
- org.bytedeco.javacpp.Pointer
-
- org.bytedeco.javacpp.ShortPointer
-
- All Implemented Interfaces:
java.lang.AutoCloseable
@Properties(inherit=javacpp.class) public class ShortPointer extends Pointer
The peer class to native pointers and arrays ofshort
. All operations take into account the position and limit, when appropriate.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer
Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.DeallocatorReference, Pointer.DeallocatorThread, Pointer.NativeDeallocator, Pointer.ProxyDeallocator, Pointer.ReferenceCounter
-
-
Field Summary
Fields Modifier and Type Field Description private static Logger
logger
-
Fields inherited from class org.bytedeco.javacpp.Pointer
address, capacity, deallocatorThread, limit, maxBytes, maxPhysicalBytes, maxRetries, position
-
-
Constructor Summary
Constructors Constructor Description ShortPointer()
ShortPointer(long size)
Allocates a nativeshort
array of the given size.ShortPointer(short... array)
Allocates enough memory for the array and copies it.ShortPointer(java.nio.ShortBuffer buffer)
For direct buffers, callsPointer(Buffer)
, while for buffers backed with an array, allocates enough memory for the array and copies it.ShortPointer(Pointer p)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
allocateArray(long size)
java.nio.ShortBuffer
asBuffer()
Same asPointer.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
getPointer(long i)
ReturnsgetPointer(getClass(), i)
.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 theshort
value to the i-th element of a native array.ShortPointer
put(short s)
ShortPointer
put(short... array)
ShortPointer
put(short[] array, int offset, int length)
Writes a portion of a Java array into the native array.int
sizeof()
Returns 1 for Pointer or BytePointer elseLoader.sizeof(getClass())
or -1 on error.-
Methods inherited from class org.bytedeco.javacpp.Pointer
address, asByteBuffer, availablePhysicalBytes, calloc, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, init, interruptDeallocatorThread, isNull, isNull, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero
-
-
-
-
Field Detail
-
logger
private static final Logger logger
-
-
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(java.nio.ShortBuffer buffer)
For direct buffers, callsPointer(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 nativeshort
array of the given size.- Parameters:
size
- the number ofshort
elements to allocate
-
ShortPointer
public ShortPointer()
- See Also:
Pointer()
-
ShortPointer
public ShortPointer(Pointer p)
- See Also:
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 thearray.position(i)
statement sort of equivalent to thearray[i]
statement in C++.- Overrides:
position
in classPointer
- 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 classPointer
- 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 classPointer
- Parameters:
capacity
- the new capacity- Returns:
- this
- See Also:
Pointer.capacity(long)
-
sizeof
public int sizeof()
Description copied from class:Pointer
Returns 1 for Pointer or BytePointer elseLoader.sizeof(getClass())
or -1 on error.
-
getPointer
public ShortPointer getPointer(long i)
Description copied from class:Pointer
ReturnsgetPointer(getClass(), i)
.- Overrides:
getPointer
in classPointer
-
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 theshort
value to the i-th element of a native array.- Parameters:
i
- the index into the arrays
- theshort
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 tooffset
- the offset into the array where to start writinglength
- 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 fromoffset
- the offset into the array where to start readinglength
- the length of data to read and write- Returns:
- this
-
asBuffer
public final java.nio.ShortBuffer asBuffer()
Description copied from class:Pointer
Same asPointer.asByteBuffer()
, but can be overridden to return subclasses of Buffer.- Overrides:
asBuffer
in classPointer
- Returns:
asByteBuffer().asShortBuffer()
- See Also:
BytePointer.asBuffer()
,asBuffer()
,IntPointer.asBuffer()
,LongPointer.asBuffer()
,FloatPointer.asBuffer()
,DoublePointer.asBuffer()
,CharPointer.asBuffer()
-
-