CharPointer (JavaCPP 1.5.7 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.javacpp.CharPointer

All Implemented Interfaces:

AutoCloseable
```
@Properties(inherit=javacpp.class)
public class CharPointer
extends Pointer
```
The peer class to native pointers and arrays of short for UTF-16. 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, Pointer.ProxyDeallocator, Pointer.ReferenceCounter

Field Summary

Fields
Modifier and Type Field and Description

private static Logger logger
- Fields inherited from class org.bytedeco.javacpp.Pointer
  address, capacity, deallocatorThread, limit, maxBytes, maxPhysicalBytes, maxRetries, position

Fields
Modifier and Type	Field and Description
`private static Logger`	`logger`

Constructor Summary

Constructors
Constructor and Description
`CharPointer()`
`CharPointer(char... array)` Allocates enough memory for the array and copies it.
`CharPointer(CharBuffer buffer)` For direct buffers, calls `Pointer(Buffer)`, while for buffers backed with an array, allocates enough memory for the array and copies it.
`CharPointer(long size)` Allocates a native `short` array of the given size.
`CharPointer(Pointer p)`
`CharPointer(String s)` Allocates enough memory for the String and copies it.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`allocateArray(long size)`
`CharBuffer`	`asBuffer()` Same as `Pointer.asByteBuffer()`, but can be overridden to return subclasses of Buffer.
`CharPointer`	`capacity(long capacity)` Sets the capacity and returns this.
`char`	`get()`
`CharPointer`	`get(char[] array)`
`CharPointer`	`get(char[] array, int offset, int length)` Reads a portion of the native array into a Java array.
`char`	`get(long i)`
`CharPointer`	`getPointer(long i)` Returns `getPointer(getClass(), i)`.
`String`	`getString()` Returns the String, assuming a null-terminated string if `limit <= position`.
`char[]`	`getStringChars()` Returns the chars, assuming a null-terminated string if `limit <= position`.
`CharPointer`	`limit(long limit)` Sets the limit and returns this.
`CharPointer`	`position(long position)` Sets the position and returns this.
`CharPointer`	`put(char... array)`
`CharPointer`	`put(char c)`
`CharPointer`	`put(char[] array, int offset, int length)` Writes a portion of a Java array into the native array.
`CharPointer`	`put(long i, char c)` Copies the `char` value to the i-th element of a native array.
`CharPointer`	`putString(String s)` Copies the String chars into native memory, including a terminating null char.
`int`	`sizeof()` Returns 1 for Pointer or BytePointer else `Loader.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, 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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - logger
```
private static final Logger logger
```
- Constructor Detail
  - CharPointer
```
public CharPointer(String s)
```
    Allocates enough memory for the String and copies it.
    
    Parameters:
    
    s - the String to copy
    
    See Also:
    
    putString(String)
  - CharPointer
```
public CharPointer(char... array)
```
    Allocates enough memory for the array and copies it.
    
    Parameters:
    
    array - the array to copy
    
    See Also:
    
    put(char[])
  - CharPointer
```
public CharPointer(CharBuffer buffer)
```
    For direct buffers, calls 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(char[])
  - CharPointer
```
public CharPointer(long size)
```
    Allocates a native short array of the given size.
    
    Parameters:
    
    size - the number of short elements to allocate
  - CharPointer
```
public CharPointer()
```
    See Also:
    
    Pointer()
  - CharPointer
```
public CharPointer(Pointer p)
```
    See Also:
    
    Pointer(Pointer)
- Method Detail
  - allocateArray
```
private void allocateArray(long size)
```
  - position
```
public CharPointer 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 CharPointer 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 CharPointer 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)
  - sizeof
```
public int sizeof()
```
    Description copied from class: Pointer
    
    Returns 1 for Pointer or BytePointer else Loader.sizeof(getClass()) or -1 on error.
    
    Overrides:
    
    sizeof in class Pointer
  - getPointer
```
public CharPointer getPointer(long i)
```
    Description copied from class: Pointer
    
    Returns getPointer(getClass(), i).
    
    Overrides:
    
    getPointer in class Pointer
  - getStringChars
```
public char[] getStringChars()
```
    Returns the chars, assuming a null-terminated string if limit <= position.
  - getString
```
public String getString()
```
    Returns the String, assuming a null-terminated string if limit <= position.
  - putString
```
public CharPointer putString(String s)
```
    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:
    
    String.toCharArray(), put(char[])
  - get
```
public char get()
```
    Returns:
    
    get(0)
  - get
```
public char get(long i)
```
    Returns:
    
    the i-th char value of a native array
  - put
```
public CharPointer put(char c)
```
    Returns:
    
    put(0, c)
  - put
```
public CharPointer put(long i,
                       char c)
```
    Copies the char value to the i-th element of a native array.
    
    Parameters:
    
    i - the index into the array
    
    c - the char value to copy
    
    Returns:
    
    this
  - get
```
public CharPointer get(char[] array)
```
    Returns:
    
    get(array, 0, array.length)
  - put
```
public CharPointer put(char... array)
```
    Returns:
    
    put(array, 0, array.length)
  - get
```
public CharPointer get(char[] 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 CharPointer put(char[] 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 CharBuffer 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().asCharBuffer()
    
    See Also:
    
    BytePointer.asBuffer(), ShortPointer.asBuffer(), IntPointer.asBuffer(), LongPointer.asBuffer(), FloatPointer.asBuffer(), DoublePointer.asBuffer(), asBuffer()

Class CharPointer

Nested Class Summary

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

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.javacpp.Pointer

Methods inherited from class java.lang.Object

Field Detail

logger

Constructor Detail

CharPointer

CharPointer

CharPointer

CharPointer

CharPointer

CharPointer

Method Detail

allocateArray

position

limit

capacity

sizeof

getPointer

getStringChars

getString

putString

get

get

put

put

get

put

get

put

asBuffer