org.bytedeco.javacpp

Class CharPointer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.CharPointer

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.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

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.Pointer(Buffer), while for buffers backed with an array, allocates enough memory for the array and copies it.
CharPointer(int 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

Methods

Modifier and Type	Method and Description
private void	allocateArray(int size)
CharBuffer	asBuffer() Same as Pointer.asByteBuffer(), but can be overridden to return subclasses of Buffer.
CharPointer	capacity(int 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(int i)
String	getString()
char[]	getStringChars()
CharPointer	limit(int limit) Sets the limit and returns this.
CharPointer	position(int 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(int 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.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asByteBuffer, capacity, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, hashCode, init, isNull, limit, memchr, memcmp, memcpy, memmove, memset, offsetof, position, put, setNull, sizeof, toString, withDeallocator, zero

Methods inherited from class java.lang.Object

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

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.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(int 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.Pointer()

CharPointer

public CharPointer(Pointer p)

See Also:

Pointer.Pointer(Pointer)

Method Detail

allocateArray

private void allocateArray(int size)

position

public CharPointer position(int 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(int)

limit

public CharPointer limit(int 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(int)

capacity

public CharPointer capacity(int 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(int)

getStringChars

public char[] getStringChars()

Returns:

the chars from the null-terminated string

getString

public String getString()

Returns:

the String from the null-terminated string

putString

public CharPointer putString(String s)

Copies the String chars into native memory, including a terminating null char.

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(int 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(int 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()