org.bytedeco.javacpp

Class BytePointer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.BytePointer

All Implemented Interfaces:

AutoCloseable

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

The peer class to native pointers and arrays of signed char, including strings. 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

Constructor Summary

Constructors

Constructor and Description
BytePointer()
BytePointer(byte... array) Allocates enough memory for the array and copies it.
BytePointer(ByteBuffer buffer) For direct buffers, calls Pointer(Buffer), while for buffers backed with an array, allocates enough memory for the array and copies it.
BytePointer(long size) Allocates a native signed char array of the given size.
BytePointer(Pointer p)
BytePointer(String s) Allocates enough memory for the encoded string and actually encodes it in the platform's default charset before copying it.
BytePointer(String s, Charset charset) Allocates enough memory for the encoded string and actually encodes it in the given charset before copying it.
BytePointer(String s, String charsetName) Allocates enough memory for the encoded string and actually encodes it in the named charset before copying it.

Method Summary

Modifier and Type	Method and Description
private void	allocateArray(long size)
ByteBuffer	asBuffer() Same as Pointer.asByteBuffer(), but can be overridden to return subclasses of Buffer.
BytePointer	capacity(long capacity) Sets the capacity and returns this.
byte	get()
BytePointer	get(byte[] array)
BytePointer	get(byte[] array, int offset, int length) Reads a portion of the native array into a Java array.
byte	get(long i)
boolean	getBool() Returns getBool(0).
boolean	getBool(long i) Returns the bool value at the i-th byte in the native array.
char	getChar() Returns getChar(0).
char	getChar(long i) Returns the char value at the i-th byte in the native array.
double	getDouble() Returns getDouble(0).
double	getDouble(long i) Returns the double value at the i-th byte in the native array.
float	getFloat() Returns getFloat(0).
float	getFloat(long i) Returns the float value at the i-th byte in the native array.
int	getInt() Returns getInt(0).
int	getInt(long i) Returns the int value at the i-th byte in the native array.
long	getLong() Returns getLong(0).
long	getLong(long i) Returns the long value at the i-th byte in the native array.
BytePointer	getPointer(long i) Returns getPointer(getClass(), i).
Pointer	getPointerValue() Returns getPointerValue(0).
Pointer	getPointerValue(long i) Returns the Pointer value at the i-th byte in the native array.
short	getShort() Returns getShort(0).
short	getShort(long i) Returns the short value at the i-th byte in the native array.
String	getString() Decodes the native bytes assuming they are encoded in the platform's default charset.
String	getString(Charset charset) Decodes the native bytes assuming they are encoded in the given charset.
String	getString(String charsetName) Decodes the native bytes assuming they are encoded in the named charset.
byte[]	getStringBytes() Returns the bytes, assuming a null-terminated string if limit <= position.
int	getUnsigned() Returns getUnsigned(0).
int	getUnsigned(long i) Returns the byte value at the i-th byte in the native array, treated as unsigned.
BytePointer	limit(long limit) Sets the limit and returns this.
BytePointer	position(long position) Sets the position and returns this.
BytePointer	put(byte... array)
BytePointer	put(byte b)
BytePointer	put(byte[] array, int offset, int length) Writes a portion of a Java array into the native array.
BytePointer	put(long i, byte b) Copies the byte value to the i-th element of a native array.
BytePointer	putBool(boolean b) Returns putBool(0, s).
BytePointer	putBool(long i, boolean b) Sets the bool value at the i-th byte in the native array.
BytePointer	putChar(char c) Returns putChar(0, s).
BytePointer	putChar(long i, char c) Sets the char value at the i-th byte in the native array.
BytePointer	putDouble(double d) Returns putDouble(0, s).
BytePointer	putDouble(long i, double d) Sets the double value at the i-th byte in the native array.
BytePointer	putFloat(float f) Returns putFloat(0, s).
BytePointer	putFloat(long i, float f) Sets the float value at the i-th byte in the native array.
BytePointer	putInt(int j) Returns putInt(0, s).
BytePointer	putInt(long i, int j) Sets the int value at the i-th byte in the native array.
BytePointer	putLong(long j) Returns putLong(0, s).
BytePointer	putLong(long i, long j) Sets the long value at the i-th byte in the native array.
BytePointer	putPointerValue(long i, Pointer p) Sets the Pointer value at the i-th byte in the native array.
BytePointer	putPointerValue(Pointer p) Returns putPointerValue(0, s).
BytePointer	putShort(long i, short s) Sets the short value at the i-th byte in the native array.
BytePointer	putShort(short s) Returns putShort(0, s).
BytePointer	putString(String s) Encodes the String into the platform's default charset and copies it in native memory, including a terminating null byte.
BytePointer	putString(String s, Charset charset) Encodes the String into the given charset and copies it in native memory, including a terminating null byte.
BytePointer	putString(String s, String charsetName) Encodes the String into the named charset and copies it in native memory, including a terminating null byte.
BytePointer	putUnsigned(int b) Returns putUnsigned(0, b).
BytePointer	putUnsigned(long i, int b) Sets the byte value at the i-th byte in the native array, treated as unsigned.
int	sizeof() Returns 1 for Pointer or BytePointer else Loader.sizeof(getClass()) or -1 on error.
static BytePointer	strcat(BytePointer dst, BytePointer src)
static BytePointer	strchr(BytePointer str, int ch)
static int	strcmp(BytePointer str1, BytePointer str2)
static int	strcoll(BytePointer str1, BytePointer str2)
static BytePointer	strcpy(BytePointer dst, BytePointer src)
static long	strcspn(BytePointer str1, BytePointer str2)
static BytePointer	strerror(int errnum)
static long	strlen(BytePointer str)
static BytePointer	strncat(BytePointer dst, BytePointer src, long n)
static int	strncmp(BytePointer str1, BytePointer str2, long n)
static BytePointer	strncpy(BytePointer dst, BytePointer src, long n)
static BytePointer	strpbrk(BytePointer str1, BytePointer str2)
static BytePointer	strrchr(BytePointer str, int ch)
static long	strspn(BytePointer str1, BytePointer str2)
static BytePointer	strstr(BytePointer str1, BytePointer str2)
static BytePointer	strtok(BytePointer str, BytePointer delim)
static long	strxfrm(BytePointer dst, BytePointer src, long n)

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

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

BytePointer

public BytePointer(String s,
                   String charsetName)
            throws UnsupportedEncodingException

Allocates enough memory for the encoded string and actually encodes it in the named charset before copying it.

Parameters:

s - the String to encode and copy

charsetName - the charset in which the bytes are encoded

Throws:

UnsupportedEncodingException

See Also:

putString(String, String)

BytePointer

public BytePointer(String s,
                   Charset charset)

Allocates enough memory for the encoded string and actually encodes it in the given charset before copying it.

Parameters:

s - the String to encode and copy

charset - the charset in which the bytes are encoded

See Also:

putString(String, Charset)

BytePointer

public BytePointer(String s)

Allocates enough memory for the encoded string and actually encodes it in the platform's default charset before copying it.

Parameters:

s - the String to encode and copy

See Also:

putString(String)

BytePointer

public BytePointer(byte... array)

Allocates enough memory for the array and copies it.

Parameters:

array - the array to copy

See Also:

put(byte[])

BytePointer

public BytePointer(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(byte[])

BytePointer

public BytePointer(long size)

Allocates a native signed char array of the given size.

Parameters:

size - the number of signed char elements to allocate

BytePointer

public BytePointer()

See Also:

Pointer()

BytePointer

public BytePointer(Pointer p)

See Also:

Pointer(Pointer)

Method Detail

allocateArray

private void allocateArray(long size)

position

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

Description copied from class: Pointer

Returns getPointer(getClass(), i).

Overrides:

getPointer in class Pointer

getStringBytes

public byte[] getStringBytes()

Returns the bytes, assuming a null-terminated string if limit <= position.

getString

public String getString(String charsetName)
                 throws UnsupportedEncodingException

Decodes the native bytes assuming they are encoded in the named charset. Assumes a null-terminated string if limit <= position.

Parameters:

charsetName - the charset in which the bytes are encoded

Returns:

a String from the null-terminated string

Throws:

UnsupportedEncodingException

getString

public String getString(Charset charset)

Decodes the native bytes assuming they are encoded in the given charset. Assumes a null-terminated string if limit <= position.

Parameters:

charset - the charset in which the bytes are encoded

Returns:

a String from the null-terminated string

getString

public String getString()

Decodes the native bytes assuming they are encoded in the platform's default charset. Assumes a null-terminated string if limit <= position.

Returns:

a String from the null-terminated string

putString

public BytePointer putString(String s,
                             String charsetName)
                      throws UnsupportedEncodingException

Encodes the String into the named charset and copies it in native memory, including a terminating null byte. Sets the limit to just before the terminating null byte.

Parameters:

s - the String to encode and copy

charsetName - the charset in which to encode the bytes

Returns:

this

Throws:

UnsupportedEncodingException

See Also:

String.getBytes(String), put(byte[])

putString

public BytePointer putString(String s,
                             Charset charset)

Encodes the String into the given charset and copies it in native memory, including a terminating null byte. Sets the limit to just before the terminating null byte.

Parameters:

s - the String to encode and copy

charset - the charset in which to encode the bytes

Returns:

this

See Also:

String.getBytes(Charset), put(byte[])

putString

public BytePointer putString(String s)

Encodes the String into the platform's default charset and copies it in native memory, including a terminating null byte. Sets the limit to just before the terminating null byte.

Parameters:

s - the String to encode and copy

Returns:

this

See Also:

String.getBytes(), put(byte[])

get

public byte get()

Returns:

get(0)

get

public byte get(long i)

Returns:

the i-th byte value of a native array

put

public BytePointer put(byte b)

Returns:

put(0, b)

put

public BytePointer put(long i,
                       byte b)

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

Parameters:

i - the index into the array

b - the byte value to copy

Returns:

this

get

public BytePointer get(byte[] array)

Returns:

get(array, 0, array.length)

put

public BytePointer put(byte... array)

Returns:

put(array, 0, array.length)

get

public BytePointer get(byte[] 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 BytePointer put(byte[] 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 ByteBuffer 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()

See Also:

asBuffer(), ShortPointer.asBuffer(), IntPointer.asBuffer(), LongPointer.asBuffer(), FloatPointer.asBuffer(), DoublePointer.asBuffer(), CharPointer.asBuffer()

getUnsigned

public int getUnsigned()

Returns getUnsigned(0).

getUnsigned

public int getUnsigned(long i)

Returns the byte value at the i-th byte in the native array, treated as unsigned.

putUnsigned

public BytePointer putUnsigned(int b)

Returns putUnsigned(0, b).

putUnsigned

public BytePointer putUnsigned(long i,
                               int b)

Sets the byte value at the i-th byte in the native array, treated as unsigned.

getShort

public short getShort()

Returns getShort(0).

getShort

@ValueGetter
 @Cast(value="short")
public short getShort(long i)

Returns the short value at the i-th byte in the native array.

putShort

public BytePointer putShort(short s)

Returns putShort(0, s).

putShort

@ValueSetter
 @Cast(value="short")
public BytePointer putShort(long i,
                                                                 short s)

Sets the short value at the i-th byte in the native array.

getInt

public int getInt()

Returns getInt(0).

getInt

@ValueGetter
 @Cast(value="int")
public int getInt(long i)

Returns the int value at the i-th byte in the native array.

putInt

public BytePointer putInt(int j)

Returns putInt(0, s).

putInt

@ValueSetter
 @Cast(value="int")
public BytePointer putInt(long i,
                                                             int j)

Sets the int value at the i-th byte in the native array.

getLong

public long getLong()

Returns getLong(0).

getLong

@ValueGetter
 @Cast(value="long long")
public long getLong(long i)

Returns the long value at the i-th byte in the native array.

putLong

public BytePointer putLong(long j)

Returns putLong(0, s).

putLong

@ValueSetter
 @Cast(value="long long")
public BytePointer putLong(long i,
                                                                    long j)

Sets the long value at the i-th byte in the native array.

getFloat

public float getFloat()

Returns getFloat(0).

getFloat

@ValueGetter
 @Cast(value="float")
public float getFloat(long i)

Returns the float value at the i-th byte in the native array.

putFloat

public BytePointer putFloat(float f)

Returns putFloat(0, s).

putFloat

@ValueSetter
 @Cast(value="float")
public BytePointer putFloat(long i,
                                                                 float f)

Sets the float value at the i-th byte in the native array.

getDouble

public double getDouble()

Returns getDouble(0).

getDouble

@ValueGetter
 @Cast(value="double")
public double getDouble(long i)

Returns the double value at the i-th byte in the native array.

putDouble

public BytePointer putDouble(double d)

Returns putDouble(0, s).

putDouble

@ValueSetter
 @Cast(value="double")
public BytePointer putDouble(long i,
                                                                   double d)

Sets the double value at the i-th byte in the native array.

getBool

public boolean getBool()

Returns getBool(0).

getBool

@ValueGetter
 @Cast(value="bool")
public boolean getBool(long i)

Returns the bool value at the i-th byte in the native array.

putBool

public BytePointer putBool(boolean b)

Returns putBool(0, s).

putBool

@ValueSetter
 @Cast(value="bool")
public BytePointer putBool(long i,
                                                               boolean b)

Sets the bool value at the i-th byte in the native array.

getChar

public char getChar()

Returns getChar(0).

getChar

@ValueGetter
 @Cast(value="short")
public char getChar(long i)

Returns the char value at the i-th byte in the native array.

putChar

public BytePointer putChar(char c)

Returns putChar(0, s).

putChar

@ValueSetter
 @Cast(value="short")
public BytePointer putChar(long i,
                                                                char c)

Sets the char value at the i-th byte in the native array.

getPointerValue

public Pointer getPointerValue()

Returns getPointerValue(0).

getPointerValue

@ValueGetter
 @Cast(value="void*")
public Pointer getPointerValue(long i)

Returns the Pointer value at the i-th byte in the native array.

putPointerValue

public BytePointer putPointerValue(Pointer p)

Returns putPointerValue(0, s).

putPointerValue

@ValueSetter
 @Cast(value="void*")
public BytePointer putPointerValue(long i,
                                                                        Pointer p)

Sets the Pointer value at the i-th byte in the native array.

strcat

@Cast(value="char*")
public static BytePointer strcat(@Cast(value="char*")
                                                       BytePointer dst,
                                                       @Cast(value="char*")
                                                       BytePointer src)

strchr

@Cast(value="char*")
public static BytePointer strchr(@Cast(value="char*")
                                                       BytePointer str,
                                                       int ch)

strcmp

public static int strcmp(@Cast(value="char*")
                         BytePointer str1,
                         @Cast(value="char*")
                         BytePointer str2)

strcoll

public static int strcoll(@Cast(value="char*")
                          BytePointer str1,
                          @Cast(value="char*")
                          BytePointer str2)

strcpy

@Cast(value="char*")
public static BytePointer strcpy(@Cast(value="char*")
                                                       BytePointer dst,
                                                       @Cast(value="char*")
                                                       BytePointer src)

strcspn

@Cast(value="size_t")
public static long strcspn(@Cast(value="char*")
                                                  BytePointer str1,
                                                  @Cast(value="char*")
                                                  BytePointer str2)

strerror

@Cast(value="char*")
public static BytePointer strerror(int errnum)

strlen

@Cast(value="size_t")
public static long strlen(@Cast(value="char*")
                                                 BytePointer str)

strncat

@Cast(value="char*")
public static BytePointer strncat(@Cast(value="char*")
                                                        BytePointer dst,
                                                        @Cast(value="char*")
                                                        BytePointer src,
                                                        @Cast(value="size_t")
                                                        long n)

strncmp

public static int strncmp(@Cast(value="char*")
                          BytePointer str1,
                          @Cast(value="char*")
                          BytePointer str2,
                          @Cast(value="size_t")
                          long n)

strncpy

@Cast(value="char*")
public static BytePointer strncpy(@Cast(value="char*")
                                                        BytePointer dst,
                                                        @Cast(value="char*")
                                                        BytePointer src,
                                                        @Cast(value="size_t")
                                                        long n)

strpbrk

@Cast(value="char*")
public static BytePointer strpbrk(@Cast(value="char*")
                                                        BytePointer str1,
                                                        @Cast(value="char*")
                                                        BytePointer str2)

strrchr

@Cast(value="char*")
public static BytePointer strrchr(@Cast(value="char*")
                                                        BytePointer str,
                                                        int ch)

strspn

@Cast(value="size_t")
public static long strspn(@Cast(value="char*")
                                                 BytePointer str1,
                                                 @Cast(value="char*")
                                                 BytePointer str2)

strstr

@Cast(value="char*")
public static BytePointer strstr(@Cast(value="char*")
                                                       BytePointer str1,
                                                       @Cast(value="char*")
                                                       BytePointer str2)

strtok

@Cast(value="char*")
public static BytePointer strtok(@Cast(value="char*")
                                                       BytePointer str,
                                                       @Cast(value="char*")
                                                       BytePointer delim)

strxfrm

@Cast(value="size_t")
public static long strxfrm(@Cast(value="char*")
                                                  BytePointer dst,
                                                  @Cast(value="char*")
                                                  BytePointer src,
                                                  @Cast(value="size_t")
                                                  long n)