Package org.bytedeco.javacpp
Class CharPointer
java.lang.Object
org.bytedeco.javacpp.Pointer
org.bytedeco.javacpp.CharPointer
- All Implemented Interfaces:
AutoCloseable
The peer class to native pointers and arrays of
short
for UTF-16.
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
FieldsFields inherited from class org.bytedeco.javacpp.Pointer
address, capacity, deallocatorThread, limit, maxBytes, maxPhysicalBytes, maxRetries, position
-
Constructor Summary
ConstructorsConstructorDescriptionCharPointer
(char... array) Allocates enough memory for the array and copies it.CharPointer
(long size) Allocates a nativeshort
array of the given size.Allocates enough memory for the String and copies it.CharPointer
(CharBuffer buffer) For direct buffers, callsPointer(Buffer)
, while for buffers backed with an array, allocates enough memory for the array and copies it. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
allocateArray
(long size) final CharBuffer
asBuffer()
Same asPointer.asByteBuffer()
, but can be overridden to return subclasses of Buffer.capacity
(long capacity) Sets the capacity and returns this.char
get()
get
(char[] array) get
(char[] array, int offset, int length) Reads a portion of the native array into a Java array.char
get
(long i) getPointer
(long i) ReturnsgetPointer(getClass(), i)
.Returns the String, assuming a null-terminated string iflimit <= position
.char[]
Returns the chars, assuming a null-terminated string iflimit <= position
.limit
(long limit) Sets the limit and returns this.position
(long position) Sets the position and returns this.put
(char c) put
(char... array) put
(char[] array, int offset, int length) Writes a portion of a Java array into the native array.put
(long i, char c) Copies thechar
value to the i-th element of a native array.Copies the String chars into native memory, including a terminating null char.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 Details
-
logger
-
-
Constructor Details
-
CharPointer
Allocates enough memory for the String and copies it.- Parameters:
s
- the String to copy- See Also:
-
CharPointer
public CharPointer(char... array) Allocates enough memory for the array and copies it.- Parameters:
array
- the array to copy- See Also:
-
CharPointer
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:
-
CharPointer
public CharPointer(long size) Allocates a nativeshort
array of the given size.- Parameters:
size
- the number ofshort
elements to allocate
-
CharPointer
public CharPointer()- See Also:
-
CharPointer
- See Also:
-
-
Method Details
-
allocateArray
private void allocateArray(long size) -
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++. -
limit
Description copied from class:Pointer
Sets the limit and returns this. Used to limit the size of an operation on this object. -
capacity
Description copied from class:Pointer
Sets the capacity and returns this. Should not be called more than once after allocation. -
sizeof
public int sizeof()Description copied from class:Pointer
Returns 1 for Pointer or BytePointer elseLoader.sizeof(getClass())
or -1 on error. -
getPointer
Description copied from class:Pointer
ReturnsgetPointer(getClass(), i)
.- Overrides:
getPointer
in classPointer
-
getStringChars
public char[] getStringChars()Returns the chars, assuming a null-terminated string iflimit <= position
. -
getString
Returns the String, assuming a null-terminated string iflimit <= position
. -
putString
Copies the String chars into native memory, including a terminating null char. Sets the limit to just before the terminating null character.- Parameters:
s
- the String to copy- Returns:
- this
- See Also:
-
get
public char get()- Returns:
get(0)
-
get
public char get(long i) - Returns:
- the i-th
char
value of a native array
-
put
- Returns:
put(0, c)
-
put
Copies thechar
value to the i-th element of a native array.- Parameters:
i
- the index into the arrayc
- thechar
value to copy- Returns:
- this
-
get
- Returns:
get(array, 0, array.length)
-
put
- Returns:
put(array, 0, array.length)
-
get
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
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
Description copied from class:Pointer
Same asPointer.asByteBuffer()
, but can be overridden to return subclasses of Buffer.
-