org.bytedeco.javacpp

Class PointerPointer<P extends Pointer>

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.PointerPointer<P>

public class PointerPointer<P extends Pointer>
extends Pointer

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

To support higher levels of indirection, we can create out of the Pointer objects returned by get(int) additional PointerPointer objects.

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

Modifier and Type	Field and Description
private P[]	pointerArray This is just to keep references to Pointer objects and prevent premature deallocation.

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
PointerPointer()
PointerPointer(byte[]... array) Allocates enough memory for the array of arrays and copies it.
PointerPointer(char[]... array) Allocates enough memory for the array of arrays and copies it.
PointerPointer(double[]... array) Allocates enough memory for the array of arrays and copies it.
PointerPointer(float[]... array) Allocates enough memory for the array of arrays and copies it.
PointerPointer(int size) Allocates a native array of void* of the given size.
PointerPointer(int[]... array) Allocates enough memory for the array of arrays and copies it.
PointerPointer(long[]... array) Allocates enough memory for the array of arrays and copies it.
PointerPointer(P... array) Allocates enough memory for the array and copies it.
PointerPointer(Pointer p)
PointerPointer(short[]... array) Allocates enough memory for the array of arrays and copies it.
PointerPointer(String... array) Allocates enough memory for the array of strings and copies it.
PointerPointer(String[] array, String charsetName) Allocates enough memory for the array of strings and copies it.

Method Summary

Methods

Modifier and Type	Method and Description
private void	allocateArray(int size)
PointerPointer<P>	capacity(int capacity) Sets the capacity and returns this.
Pointer	get()
P	get(Class<P> cls)
P	get(Class<P> cls, int i)
Pointer	get(int i)
String	getString(int i)
String	getString(int i, String charsetName)
PointerPointer<P>	limit(int limit) Sets the limit and returns this.
PointerPointer<P>	position(int position) Sets the position and returns this.
PointerPointer<P>	put(byte[]... array) Creates one by one a new BytePointer for each byte[], and writes them into the native void* array.
PointerPointer<P>	put(char[]... array) Creates one by one a new CharPointer for each char[], and writes them into the native void* array.
PointerPointer<P>	put(double[]... array) Creates one by one a new DoublePointer for each double[], and writes them into the native void* array.
PointerPointer<P>	put(float[]... array) Creates one by one a new FloatPointer for each float[], and writes them into the native void* array.
PointerPointer<P>	put(int[]... array) Creates one by one a new IntPointer for each int[], and writes them into the native void* array.
PointerPointer<P>	put(int i, Pointer p) Copies the Pointer value to the i-th element of a native array.
PointerPointer<P>	put(long[]... array) Creates one by one a new LongPointer for each long[], and writes them into the native void* array.
PointerPointer<P>	put(P... array) Writes the Pointer values into the native void* array.
PointerPointer<P>	put(Pointer p) Calls in effect memcpy(this.address + this.position, p.address + p.position, length), where length = sizeof(p) * (p.limit - p.position).
PointerPointer<P>	put(short[]... array) Creates one by one a new ShortPointer for each short[], and writes them into the native void* array.
PointerPointer<P>	putString(String... array) Creates one by one a new BytePointer for each String, and writes them into the native void* array.
PointerPointer<P>	putString(String[] array, String charsetName) Creates one by one a new BytePointer for each String, and writes them into the native void* array.

Methods inherited from class org.bytedeco.javacpp.Pointer

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

Methods inherited from class java.lang.Object

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

Field Detail

pointerArray

private P extends Pointer[] pointerArray

This is just to keep references to Pointer objects and prevent premature deallocation.

Constructor Detail

PointerPointer

public PointerPointer(String... array)

Allocates enough memory for the array of strings and copies it.

Parameters:

array - the array of strings to copy

See Also:

putString(String[])

PointerPointer

public PointerPointer(String[] array,
              String charsetName)
               throws UnsupportedEncodingException

Allocates enough memory for the array of strings and copies it.

Parameters:

array - the array of strings to copy

charsetName - the charset in which the bytes are encoded

Throws:

UnsupportedEncodingException

See Also:

putString(String[], String)

PointerPointer

public PointerPointer(P... array)

Allocates enough memory for the array and copies it.

Parameters:

array - the array to copy

See Also:

put(Pointer[])

PointerPointer

public PointerPointer(byte[]... array)

Allocates enough memory for the array of arrays and copies it.

Parameters:

array - the array of arrays to copy

See Also:

put(byte[][])

PointerPointer

public PointerPointer(short[]... array)

Allocates enough memory for the array of arrays and copies it.

Parameters:

array - the array of arrays to copy

See Also:

put(short[][])

PointerPointer

public PointerPointer(int[]... array)

Allocates enough memory for the array of arrays and copies it.

Parameters:

array - the array of arrays to copy

See Also:

put(int[][])

PointerPointer

public PointerPointer(long[]... array)

Allocates enough memory for the array of arrays and copies it.

Parameters:

array - the array of arrays to copy

See Also:

put(long[][])

PointerPointer

public PointerPointer(float[]... array)

Allocates enough memory for the array of arrays and copies it.

Parameters:

array - the array of arrays to copy

See Also:

put(float[][])

PointerPointer

public PointerPointer(double[]... array)

Allocates enough memory for the array of arrays and copies it.

Parameters:

array - the array of arrays to copy

See Also:

put(double[][])

PointerPointer

public PointerPointer(char[]... array)

Allocates enough memory for the array of arrays and copies it.

Parameters:

array - the array of arrays to copy

See Also:

put(char[][])

PointerPointer

public PointerPointer(int size)

Allocates a native array of void* of the given size.

Parameters:

size - the number of void* elements to allocate

PointerPointer

public PointerPointer()

See Also:

Pointer.Pointer()

PointerPointer

public PointerPointer(Pointer p)

See Also:

Pointer.Pointer(Pointer)

Method Detail

allocateArray

private void allocateArray(int size)

position

public PointerPointer<P> 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 PointerPointer<P> 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 PointerPointer<P> 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)

getString

public String getString(int i)

Returns:

get(BytePointer.class, i).getString()

See Also:

BytePointer.getString()

getString

public String getString(int i,
               String charsetName)
                 throws UnsupportedEncodingException

Returns:

get(BytePointer.class, i).getString(charsetName)

Throws:

UnsupportedEncodingException

See Also:

BytePointer.getString(String)

putString

public PointerPointer<P> putString(String... array)

Creates one by one a new BytePointer for each String, and writes them into the native void* array.

Parameters:

array - the array of String to read from

Returns:

this

putString

public PointerPointer<P> putString(String[] array,
                          String charsetName)
                                            throws UnsupportedEncodingException

Creates one by one a new BytePointer for each String, and writes them into the native void* array.

Parameters:

array - the array of String to read from

charsetName - the charset in which the bytes are encoded

Returns:

this

Throws:

UnsupportedEncodingException

put

public PointerPointer<P> put(P... array)

Writes the Pointer values into the native void* array.

Parameters:

array - the array of Pointer values to read from

Returns:

this

put

public PointerPointer<P> put(byte[]... array)

Creates one by one a new BytePointer for each byte[], and writes them into the native void* array.

Parameters:

array - the array of byte[] to read from

Returns:

this

put

public PointerPointer<P> put(short[]... array)

Creates one by one a new ShortPointer for each short[], and writes them into the native void* array.

Parameters:

array - the array of short[] to read from

Returns:

this

put

public PointerPointer<P> put(int[]... array)

Creates one by one a new IntPointer for each int[], and writes them into the native void* array.

Parameters:

array - the array of int[] to read from

Returns:

this

put

public PointerPointer<P> put(long[]... array)

Creates one by one a new LongPointer for each long[], and writes them into the native void* array.

Parameters:

array - the array of long[] to read from

Returns:

this

put

public PointerPointer<P> put(float[]... array)

Creates one by one a new FloatPointer for each float[], and writes them into the native void* array.

Parameters:

array - the array of float[] to read from

Returns:

this

put

public PointerPointer<P> put(double[]... array)

Creates one by one a new DoublePointer for each double[], and writes them into the native void* array.

Parameters:

array - the array of double[] to read from

Returns:

this

put

public PointerPointer<P> put(char[]... array)

Creates one by one a new CharPointer for each char[], and writes them into the native void* array.

Parameters:

array - the array of char[] to read from

Returns:

this

get

public Pointer get()

Returns:

get(0)

get

public P get(Class<P> cls)

Returns:

get(cls, 0)

get

public Pointer get(int i)

Returns:

the i-th Pointer value of a native array

get

public P get(Class<P> cls,
    int i)

Returns:

in the given class the i-th Pointer value of a native array

put

public PointerPointer<P> put(Pointer p)

Description copied from class: Pointer

Calls in effect memcpy(this.address + this.position, p.address + p.position, length), where length = sizeof(p) * (p.limit - p.position). If limit == 0, it uses position + 1 instead. The way the methods were designed allows constructs such as this.position(0).put(p.position(13).limit(42)).

Overrides:

put in class Pointer

Parameters:

p - the Pointer from which to copy memory

Returns:

put(0, p)

put

public PointerPointer<P> put(int i,
                    Pointer p)

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

Parameters:

i - the index into the array

p - the Pointer value to copy

Returns:

this