Top Inners Fields Constructors Methods
jnr.ffi.provider

public final Class DefaultObjectReferenceManager

extends ObjectReferenceManager
Class Inheritance
Imports
jnr.ffi.ObjectReferenceManager, .Pointer, .Runtime, java.util.concurrent.ConcurrentHashMap, .ConcurrentMap

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private final ConcurrentMap<Long, DefaultObjectReferenceManager.ObjectReference>
private final Runtime

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Pointer
add(Object
The java object to generate a reference for
obj
)

Implements abstract jnr.ffi.ObjectReferenceManager.add.

Adds a mapping from a java object to a unique native address.
public Object
get(Pointer
a native memory pointer.
reference
)

Implements abstract jnr.ffi.ObjectReferenceManager.get.

Gets the java object that is mapped to the native memory address referred to by reference.
private long
id(Object obj)

public boolean
remove(Pointer
a native memory pointer.
reference
)

Implements abstract jnr.ffi.ObjectReferenceManager.remove.

Removes a mapping from java object to native pointer.
Inherited from jnr.ffi.ObjectReferenceManager:
freeReferencegetObjectnewInstancenewReference

Field Detail

referencesback to summary
private final ConcurrentMap<Long, DefaultObjectReferenceManager.ObjectReference> references
runtimeback to summary
private final Runtime runtime

Constructor Detail

DefaultObjectReferenceManagerback to summary
public DefaultObjectReferenceManager(Runtime runtime)

Method Detail

addback to summary
public Pointer add(Object obj)

Implements abstract jnr.ffi.ObjectReferenceManager.add.

Doc from jnr.ffi.ObjectReferenceManager.add.

Adds a mapping from a java object to a unique native address. Each call to this method is guaranteed to produce a memory address unique within the ObjectReferenceManager instance, even for the same object.

A strong reference to object is maintained internally, until remove(Pointer) is called.

Parameters
obj:Object

The java object to generate a reference for

Returns:Pointer

A pointer representing the unique id.

getback to summary
public Object get(Pointer reference)

Implements abstract jnr.ffi.ObjectReferenceManager.get.

Doc from jnr.ffi.ObjectReferenceManager.get.

Gets the java object that is mapped to the native memory address referred to by reference.

Parameters
reference:Pointer

a native memory pointer.

Returns:Object

The java object corresponding to pointer.

idback to summary
private long id(Object obj)
removeback to summary
public boolean remove(Pointer reference)

Implements abstract jnr.ffi.ObjectReferenceManager.remove.

Doc from jnr.ffi.ObjectReferenceManager.remove.

Removes a mapping from java object to native pointer.

Parameters
reference:Pointer

a native memory pointer.

Returns:boolean

true if the mapping was removed.

jnr.ffi.provider back to summary

private final Class DefaultObjectReferenceManager.ObjectReference

extends InAccessibleMemoryIO
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final Object

Constructor Summary

AccessConstructor and Description
public
ObjectReference(Runtime runtime, long address, Object referent)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public long
size()

Implements abstract jnr.ffi.Pointer.size.

Gets the size of this memory object in bytes (optional operation).
Inherited from jnr.ffi.provider.InAccessibleMemoryIO:
arrayarrayLengtharrayOffseterrorgetgetgetgetgetgetgetBytegetDoublegetFloatgetIntgetLonggetLongLonggetPointergetPointergetShortgetStringgetStringhasArrayindexOfputputputputputputputByteputDoubleputFloatputIntputLongputLongLongputPointerputShortputStringsetMemory

Field Detail

referentback to summary
private final Object referent

Constructor Detail

ObjectReferenceback to summary
public ObjectReference(Runtime runtime, long address, Object referent)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
sizeback to summary
public long size()

Implements abstract jnr.ffi.Pointer.size.

Doc from jnr.ffi.Pointer.size.

Gets the size of this memory object in bytes (optional operation).

Returns:long

the size of the memory area this Pointer points to. If the size is unknown, java.lang.Long#MAX_VALUE is returned}.