org.bytedeco.javacpp

Class BooleanPointer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.BooleanPointer

All Implemented Interfaces:

AutoCloseable

@Properties(inherit=javacpp.class)
public class BooleanPointer
extends Pointer

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

Assumes sizeof(jboolean) is always 1 byte with false == 0 and true == 1.

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

Constructor Summary

Constructors

Constructor and Description
BooleanPointer()
BooleanPointer(boolean... array) Allocates enough memory for the array and copies it.
BooleanPointer(ByteBuffer buffer) For direct buffers, calls Pointer(Buffer), while for buffers backed with an array, allocates enough memory for the array and copies it.
BooleanPointer(long size) Allocates a native boolean array of the given size.
BooleanPointer(Pointer p)

Method Summary

Modifier and Type	Method and Description
private void	allocateArray(long size)
BooleanPointer	capacity(long capacity) Sets the capacity and returns this.
boolean	get()
BooleanPointer	get(boolean[] array)
BooleanPointer	get(boolean[] array, int offset, int length) Reads a portion of the native array into a Java array.
boolean	get(long i)
BooleanPointer	getPointer(long i) Returns getPointer(getClass(), i).
BooleanPointer	limit(long limit) Sets the limit and returns this.
BooleanPointer	position(long position) Sets the position and returns this.
BooleanPointer	put(boolean... array)
BooleanPointer	put(boolean b)
BooleanPointer	put(boolean[] array, int offset, int length) Writes a portion of a Java array into the native array.
BooleanPointer	put(long i, boolean b) Copies the boolean value to the i-th element of a native array.
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, asBuffer, 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

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

BooleanPointer

public BooleanPointer(boolean... array)

Allocates enough memory for the array and copies it.

Parameters:

array - the array to copy

See Also:

put(boolean[])

BooleanPointer

public BooleanPointer(ByteBuffer 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(boolean[])

BooleanPointer

public BooleanPointer(long size)

Allocates a native boolean array of the given size.

Parameters:

size - the number of boolean elements to allocate

BooleanPointer

public BooleanPointer()

See Also:

Pointer()

BooleanPointer

public BooleanPointer(Pointer p)

See Also:

Pointer(Pointer)

Method Detail

allocateArray

private void allocateArray(long size)

position

public BooleanPointer 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 BooleanPointer 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 BooleanPointer 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 BooleanPointer getPointer(long i)

Description copied from class: Pointer

Returns getPointer(getClass(), i).

Overrides:

getPointer in class Pointer

get

public boolean get()

Returns:

get(0)

get

public boolean get(long i)

Returns:

the i-th boolean value of a native array

put

public BooleanPointer put(boolean b)

Returns:

put(0, b)

put

public BooleanPointer put(long i,
                          boolean b)

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

Parameters:

i - the index into the array

b - the boolean value to copy

Returns:

this

get

public BooleanPointer get(boolean[] array)

Returns:

get(array, 0, array.length)

put

public BooleanPointer put(boolean... array)

Returns:

put(array, 0, array.length)

get

public BooleanPointer get(boolean[] 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 BooleanPointer put(boolean[] 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