Package jnr.ffi.provider
Class AbstractArrayMemoryIO
- java.lang.Object
-
- jnr.ffi.Pointer
-
- jnr.ffi.provider.AbstractMemoryIO
-
- jnr.ffi.provider.AbstractArrayMemoryIO
-
- Direct Known Subclasses:
ArrayMemoryIO
public abstract class AbstractArrayMemoryIO extends AbstractMemoryIO
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
AbstractArrayMemoryIO.ArrayIO
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractArrayMemoryIO(Runtime runtime, byte[] buffer)
protected
AbstractArrayMemoryIO(Runtime runtime, byte[] buffer, int offset, int length)
protected
AbstractArrayMemoryIO(Runtime runtime, int size)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte[]
array()
Returns the array that backs this pointer.int
arrayLength()
Returns the length of this pointer's backing array that is used by this pointer.int
arrayOffset()
Returns the offset within this pointer's backing array of the first element.void
clear()
void
get(long offset, byte[] dst, int off, int len)
Bulk get method for multiplebyte
values.void
get(long offset, double[] dst, int off, int len)
Bulk get method for multipledouble
values.void
get(long offset, float[] dst, int off, int len)
Bulk get method for multiplefloat
values.void
get(long offset, int[] dst, int off, int len)
Bulk get method for multipleint
values.void
get(long offset, long[] dst, int off, int len)
Bulk get method for multiplelong
values.void
get(long offset, short[] dst, int off, int len)
Bulk get method for multipleshort
values.long
getAddress(long offset)
Reads a native memory address value at the given offset.protected AbstractArrayMemoryIO.ArrayIO
getArrayIO()
byte
getByte(long offset)
Reads anbyte
(8 bit) value at the given offset.double
getDouble(long offset)
Reads adouble
(64 bit) value at the given offset.float
getFloat(long offset)
Reads afloat
(32 bit) value at the given offset.int
getInt(long offset)
Reads anint
(32 bit) value at the given offset.long
getLongLong(long offset)
Reads along
(64 bit) value at the given offset.short
getShort(long offset)
Reads ashort
(16 bit) value at the given offset.java.lang.String
getString(long offset)
Reads anString
value at the given offset.java.lang.String
getString(long offset, int maxLength, java.nio.charset.Charset cs)
Reads aString
value at the given offset, using a specificCharset
boolean
hasArray()
Indicates whether thisPointer
instance is backed by an array.protected int
index(long off)
int
indexOf(long offset, byte value)
Returns the location of a byte value within the memory area represented by thisPointer
.int
indexOf(long offset, byte value, int maxlen)
Returns the location of a byte value within the memory area represented by thisPointer
.boolean
isNull()
int
length()
int
offset()
void
put(long offset, byte[] src, int off, int len)
Bulk put method for multiplebyte
values.void
put(long offset, double[] src, int off, int len)
Bulk put method for multipledouble
values.void
put(long offset, float[] src, int off, int len)
Bulk put method for multiplefloat
values.void
put(long offset, int[] src, int off, int len)
Bulk put method for multipleint
values.void
put(long offset, long[] src, int off, int len)
Bulk put method for multiplelong
values.void
put(long offset, short[] src, int off, int len)
Bulk put method for multipleshort
values.void
putAddress(long offset, long value)
Writes a native memory address value at the given offset.void
putByte(long offset, byte value)
Writes abyte
(8 bit) value at the given offset.void
putDouble(long offset, double value)
Writes adouble
(64 bit, double precision) value at the given offset.void
putFloat(long offset, float value)
Writes afloat
(32 bit, single precision) value at the given offset.void
putInt(long offset, int value)
Writes anint
(32 bit) value at the given offset.void
putLongLong(long offset, long value)
Writes along
(64 bit) value at the given offset.void
putShort(long offset, short value)
Writes ashort
(16 bit) value at the given offset.void
putString(long offset, java.lang.String string, int maxLength, java.nio.charset.Charset cs)
Writes aString
value at the given offset, using a specificCharset
void
putZeroTerminatedByteArray(long offset, byte[] src, int off, int len)
protected int
remaining(long offset)
void
setMemory(long offset, long size, byte value)
Sets the value of each byte in the memory area represented by thisPointer
.long
size()
Gets the size of this memory object in bytes (optional operation).-
Methods inherited from class jnr.ffi.provider.AbstractMemoryIO
checkBounds, checkBounds, getInt, getLong, getNativeLong, putAddress, putInt, putLong, putNativeLong, slice, slice, transferFrom, transferTo
-
Methods inherited from class jnr.ffi.Pointer
address, get, getNullTerminatedPointerArray, getNullTerminatedStringArray, getPointer, getPointer, getRuntime, isDirect, newIntPointer, put, putPointer, toString, wrap, wrap, wrap
-
-
-
-
Method Detail
-
getArrayIO
protected final AbstractArrayMemoryIO.ArrayIO getArrayIO()
-
array
public final byte[] array()
Description copied from class:Pointer
Returns the array that backs this pointer.
-
offset
public final int offset()
-
length
public final int length()
-
arrayLength
public final int arrayLength()
Description copied from class:Pointer
Returns the length of this pointer's backing array that is used by this pointer.- Specified by:
arrayLength
in classPointer
- Returns:
- The length of the backing array used
-
arrayOffset
public final int arrayOffset()
Description copied from class:Pointer
Returns the offset within this pointer's backing array of the first element.- Specified by:
arrayOffset
in classPointer
- Returns:
- The offset of the first element on the backing array
-
hasArray
public final boolean hasArray()
Description copied from class:Pointer
Indicates whether thisPointer
instance is backed by an array.
-
size
public final long size()
Description copied from class:Pointer
Gets the size of this memory object in bytes (optional operation).
-
index
protected final int index(long off)
-
remaining
protected final int remaining(long offset)
-
isNull
public final boolean isNull()
-
getString
public java.lang.String getString(long offset)
Description copied from class:Pointer
Reads anString
value at the given offset.
-
getString
public java.lang.String getString(long offset, int maxLength, java.nio.charset.Charset cs)
Description copied from class:Pointer
Reads aString
value at the given offset, using a specificCharset
- Specified by:
getString
in classPointer
- Parameters:
offset
- the offset from the start of the memory thisPointer
represents at which the value will be read.maxLength
- the maximum size of memory to search for a NUL byte.cs
- theCharset
to use to decode the string.- Returns:
- the
String
value read from memory.
-
putString
public void putString(long offset, java.lang.String string, int maxLength, java.nio.charset.Charset cs)
Description copied from class:Pointer
Writes aString
value at the given offset, using a specificCharset
- Specified by:
putString
in classPointer
- Parameters:
offset
- the offset from the start of the memory thisPointer
represents at which the value will be written.string
- the string to be written.maxLength
- the maximum size of memory to use to store the string.cs
- theCharset
to use to decode the string.
-
putZeroTerminatedByteArray
public void putZeroTerminatedByteArray(long offset, byte[] src, int off, int len)
-
getByte
public final byte getByte(long offset)
Description copied from class:Pointer
Reads anbyte
(8 bit) value at the given offset.
-
getShort
public final short getShort(long offset)
Description copied from class:Pointer
Reads ashort
(16 bit) value at the given offset.
-
getInt
public final int getInt(long offset)
Description copied from class:Pointer
Reads anint
(32 bit) value at the given offset.
-
getLongLong
public final long getLongLong(long offset)
Description copied from class:Pointer
Reads along
(64 bit) value at the given offset.- Specified by:
getLongLong
in classPointer
- Parameters:
offset
- The offset from the start of the memory thisPointer
represents at which the value will be read.- Returns:
- the
long
value at the offset.
-
getAddress
public final long getAddress(long offset)
Description copied from class:Pointer
Reads a native memory address value at the given offset.A native address can be either 32 or 64 bits in size, depending on the cpu architecture.
- Overrides:
getAddress
in classAbstractMemoryIO
- Parameters:
offset
- The offset from the start of the memory thisPointer
represents at which the value will be read.- Returns:
- the native address value contained in the memory at the offset
- See Also:
Address
-
getFloat
public final float getFloat(long offset)
Description copied from class:Pointer
Reads afloat
(32 bit) value at the given offset.
-
getDouble
public final double getDouble(long offset)
Description copied from class:Pointer
Reads adouble
(64 bit) value at the given offset.
-
putByte
public final void putByte(long offset, byte value)
Description copied from class:Pointer
Writes abyte
(8 bit) value at the given offset.
-
putShort
public final void putShort(long offset, short value)
Description copied from class:Pointer
Writes ashort
(16 bit) value at the given offset.
-
putInt
public final void putInt(long offset, int value)
Description copied from class:Pointer
Writes anint
(32 bit) value at the given offset.
-
putLongLong
public final void putLongLong(long offset, long value)
Description copied from class:Pointer
Writes along
(64 bit) value at the given offset.- Specified by:
putLongLong
in classPointer
- Parameters:
offset
- The offset from the start of the memory thisPointer
represents at which the value will be written.value
- thelong
value to be written.
-
putAddress
public final void putAddress(long offset, long value)
Description copied from class:Pointer
Writes a native memory address value at the given offset.A native address can be either 32 or 64 bits in size, depending on the cpu architecture.
- Overrides:
putAddress
in classAbstractMemoryIO
- Parameters:
offset
- The offset from the start of the memory thisPointer
represents at which the value will be written.value
- The native address value to be written.- See Also:
Address
-
putFloat
public final void putFloat(long offset, float value)
Description copied from class:Pointer
Writes afloat
(32 bit, single precision) value at the given offset.
-
putDouble
public final void putDouble(long offset, double value)
Description copied from class:Pointer
Writes adouble
(64 bit, double precision) value at the given offset.
-
get
public final void get(long offset, byte[] dst, int off, int len)
Description copied from class:Pointer
Bulk get method for multiplebyte
values. This method reads multiplebyte
values from consecutive addresses, beginning at the given offset, and stores them in an array.- Specified by:
get
in classPointer
- Parameters:
offset
- the offset from the start of the memory thisPointer
represents at which the first value will be read.dst
- the array into which values are to be stored.off
- the start index in thedst
array to begin storing the values.len
- the number of values to be read.
-
put
public final void put(long offset, byte[] src, int off, int len)
Description copied from class:Pointer
Bulk put method for multiplebyte
values. This method writes multiplebyte
values to consecutive addresses, beginning at the given offset, from an array.- Specified by:
put
in classPointer
- Parameters:
offset
- the offset from the start of the memory thisPointer
represents at which the first value will be written.src
- the array to get values from.off
- the start index in thedst
array to begin reading values.len
- the number of values to be written.
-
get
public final void get(long offset, short[] dst, int off, int len)
Description copied from class:Pointer
Bulk get method for multipleshort
values. This method reads multipleshort
values from consecutive addresses, beginning at the given offset, and stores them in an array.- Specified by:
get
in classPointer
- Parameters:
offset
- The offset from the start of the memory thisPointer
represents at which the first value will be read.dst
- The array into which values are to be stored.off
- the start index in thedst
array to begin storing the values.len
- the number of values to be read.
-
put
public final void put(long offset, short[] src, int off, int len)
Description copied from class:Pointer
Bulk put method for multipleshort
values. This method writes multipleshort
values to consecutive addresses, beginning at the given offset, from an array.- Specified by:
put
in classPointer
- Parameters:
offset
- the offset from the start of the memory thisPointer
represents at which the first value will be written.src
- the array to get values from.off
- the start index in thedst
array to begin reading values.len
- the number of values to be written.
-
get
public final void get(long offset, int[] dst, int off, int len)
Description copied from class:Pointer
Bulk get method for multipleint
values. This method reads multipleint
values from consecutive addresses, beginning at the given offset, and stores them in an array.- Specified by:
get
in classPointer
- Parameters:
offset
- The offset from the start of the memory thisPointer
represents at which the first value will be read.dst
- The array into which values are to be stored.off
- the start index in thedst
array to begin storing the values.len
- the number of values to be read.
-
put
public final void put(long offset, int[] src, int off, int len)
Description copied from class:Pointer
Bulk put method for multipleint
values. This method writes multipleint
values to consecutive addresses, beginning at the given offset, from an array.- Specified by:
put
in classPointer
- Parameters:
offset
- the offset from the start of the memory thisPointer
represents at which the first value will be written.src
- the array to get values from.off
- the start index in thedst
array to begin reading values.len
- the number of values to be written.
-
get
public final void get(long offset, long[] dst, int off, int len)
Description copied from class:Pointer
Bulk get method for multiplelong
values. This method reads multiplelong
values from consecutive addresses, beginning at the given offset, and stores them in an array.- Specified by:
get
in classPointer
- Parameters:
offset
- The offset from the start of the memory thisPointer
represents at which the first value will be read.dst
- The array into which values are to be stored.off
- the start index in thedst
array to begin storing the values.len
- the number of values to be read.
-
put
public final void put(long offset, long[] src, int off, int len)
Description copied from class:Pointer
Bulk put method for multiplelong
values. This method writes multiplelong
values to consecutive addresses, beginning at the given offset, from an array.- Specified by:
put
in classPointer
- Parameters:
offset
- the offset from the start of the memory thisPointer
represents at which the first value will be written.src
- the array to get values from.off
- the start index in thedst
array to begin reading values.len
- the number of values to be written.
-
get
public final void get(long offset, float[] dst, int off, int len)
Description copied from class:Pointer
Bulk get method for multiplefloat
values. This method reads multiplefloat
values from consecutive addresses, beginning at the given offset, and stores them in an array.- Specified by:
get
in classPointer
- Parameters:
offset
- The offset from the start of the memory thisPointer
represents at which the first value will be read.dst
- The array into which values are to be stored.off
- the start index in thedst
array to begin storing the values.len
- the number of values to be read.
-
put
public final void put(long offset, float[] src, int off, int len)
Description copied from class:Pointer
Bulk put method for multiplefloat
values. This method writes multiplefloat
values to consecutive addresses, beginning at the given offset, from an array.- Specified by:
put
in classPointer
- Parameters:
offset
- the offset from the start of the memory thisPointer
represents at which the first value will be written.src
- the array to get values from.off
- the start index in thedst
array to begin reading values.len
- the number of values to be written.
-
get
public final void get(long offset, double[] dst, int off, int len)
Description copied from class:Pointer
Bulk get method for multipledouble
values. This method reads multipledouble
values from consecutive addresses, beginning at the given offset, and stores them in an array.- Specified by:
get
in classPointer
- Parameters:
offset
- The offset from the start of the memory thisPointer
represents at which the first value will be read.dst
- The array into which values are to be stored.off
- the start index in thedst
array to begin storing the values.len
- the number of values to be read.
-
put
public final void put(long offset, double[] src, int off, int len)
Description copied from class:Pointer
Bulk put method for multipledouble
values. This method writes multipledouble
values to consecutive addresses, beginning at the given offset, from an array.- Specified by:
put
in classPointer
- Parameters:
offset
- the offset from the start of the memory thisPointer
represents at which the first value will be written.src
- the array to get values from.off
- the start index in thedst
array to begin reading values.len
- the number of values to be written.
-
indexOf
public final int indexOf(long offset, byte value)
Description copied from class:Pointer
Returns the location of a byte value within the memory area represented by thisPointer
.- Overrides:
indexOf
in classAbstractMemoryIO
- Parameters:
offset
- the offset from the start of the memory location thisPointer
represents to begin searching.value
- thebyte
value to locate.- Returns:
- the offset from the start of the search area (i.e. relative to the offset parameter), or -1 if not found.
-
indexOf
public final int indexOf(long offset, byte value, int maxlen)
Description copied from class:Pointer
Returns the location of a byte value within the memory area represented by thisPointer
.- Specified by:
indexOf
in classPointer
- Parameters:
offset
- the offset from the start of the memory location thisPointer
represents to begin searching.value
- thebyte
value to locate.maxlen
- the maximum number of bytes to search for the desired value.- Returns:
- the offset from the start of the search area (i.e. relative to the offset parameter), or -1 if not found.
-
setMemory
public final void setMemory(long offset, long size, byte value)
Description copied from class:Pointer
Sets the value of each byte in the memory area represented by thisPointer
. to a specified value.
-
clear
public final void clear()
-
-