UnsafeOperations (Jadira Framework Parent 7.0.0.CR1 API)

java.lang.Object
- org.jadira.reflection.access.unsafe.UnsafeOperations

```
public final class UnsafeOperations
extends Object
```
A set of utility methods for working with sun.misc.Unsafe. Address shallow and deep copying, field access and field manipulation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`allocateInstance(Class<T> clazz)` Construct and allocate on the heap an instant of the given class, without calling the class constructor
`void`	`copyPrimitiveAtOffset(Object source, Object copy, Class<?> type, long offset)` Copies the primitive of the specified type from the given field offset in the source object to the same location in the copy
`void`	`copyPrimitiveField(Object source, Object copy, Field field)` Copy the value from the given field from the source into the target.
`<T> T`	`deepCopy(T obj)` Performs a deep copy of the object.
`<T> T`	`deepCopy(T o, IdentityHashMap<Object,Object> referencesToReuse)` Performs a deep copy of the object.
`Object`	`deepCopyArray(Object arrayOriginal, IdentityHashMap<Object,Object> visited)` Performs a deep copy of the array.
`void`	`deepCopyArrayAtOffset(Object source, Object copy, Class<?> fieldClass, long offset)` Copies the array of the specified type from the given field offset in the source object to the same location in the copy, visiting the array during the copy so that its contents are also copied
`void`	`deepCopyArrayAtOffset(Object source, Object copy, Class<?> fieldClass, long offset, IdentityHashMap<Object,Object> referencesToReuse)` Copies the array of the specified type from the given field offset in the source object to the same location in the copy, visiting the array during the copy so that its contents are also copied
`void`	`deepCopyArrayField(Object obj, Object copy, Field field)` Copies the array of the specified type from the given field in the source object to the same field in the copy, visiting the array during the copy so that its contents are also copied
`void`	`deepCopyArrayField(Object obj, Object copy, Field field, IdentityHashMap<Object,Object> referencesToReuse)` Copies the array of the specified type from the given field in the source object to the same field in the copy, visiting the array during the copy so that its contents are also copied
`void`	`deepCopyObjectAtOffset(Object source, Object copy, Class<?> fieldClass, long offset)` Copies the object of the specified type from the given field offset in the source object to the same location in the copy, visiting the object during the copy so that its fields are also copied
`void`	`deepCopyObjectAtOffset(Object source, Object copy, Class<?> fieldClass, long offset, IdentityHashMap<Object,Object> referencesToReuse)` Copies the object of the specified type from the given field offset in the source object to the same location in the copy, visiting the object during the copy so that its fields are also copied
`void`	`deepCopyObjectField(Object obj, Object copy, Field field)` Copies the object of the specified type from the given field in the source object to the same field in the copy, visiting the object during the copy so that its fields are also copied
`void`	`deepCopyObjectField(Object source, Object copy, Field field, IdentityHashMap<Object,Object> referencesToReuse)` Copies the object of the specified type from the given field in the source object to the same field in the copy, visiting the object during the copy so that its fields are also copied
`long`	`deepSizeOf(Object o)` Determines the deep memory size of the given object (object or array), visiting all its references
`Object`	`fromAddress(long address)` Returns the object located at the given memory address
`int`	`getAddressSize()` Get the size in bytes of a native pointer - either 4 or 8 (for 32-bit or 64-bit JRE).
`boolean`	`getBoolean(Object parent, long offset)` Retrieve the value at the given offset of the supplied parent object
`byte`	`getByte(Object parent, long offset)` Retrieve the value at the given offset of the supplied parent object
`char`	`getChar(Object parent, long offset)` Retrieve the value at the given offset of the supplied parent object
`double`	`getDouble(Object parent, long offset)` Retrieve the value at the given offset of the supplied parent object
`float`	`getFloat(Object parent, long offset)` Retrieve the value at the given offset of the supplied parent object
`int`	`getInt(Object parent, long offset)` Retrieve the value at the given offset of the supplied parent object
`long`	`getLong(Object parent, long offset)` Retrieve the value at the given offset of the supplied parent object
`Object`	`getObject(Object parent, long offset)` Retrieve the object at the given offset of the supplied parent object
`long`	`getObjectFieldOffset(Field f)` Gets an offset for the given field relative to the field base.
`short`	`getShort(Object parent, long offset)` Retrieve the value at the given offset of the supplied parent object
`static UnsafeOperations`	`getUnsafeOperations()` Returns the (singleton) UnsafeOperations instance
`static boolean`	`isUnsafeAvailable()` Check whether the Unsafe API is accessible
`void`	`putBoolean(Object parent, long offset, boolean value)` Puts the value at the given offset of the supplied parent object
`void`	`putByte(Object parent, long offset, byte value)` Puts the value at the given offset of the supplied parent object
`void`	`putChar(Object parent, long offset, char value)` Puts the value at the given offset of the supplied parent object
`void`	`putDefaultBoolean(Object parent, long offset)` Resets to false the boolean value at the given offset of the supplied parent object
`void`	`putDefaultByte(Object parent, long offset)` Resets to 0 the byte value at the given offset of the supplied parent object
`void`	`putDefaultChar(Object parent, long offset)` Resets to u0000 the char value at the given offset of the supplied parent object
`void`	`putDefaultDouble(Object parent, long offset)` Resets to 0.0d the double value at the given offset of the supplied parent object
`void`	`putDefaultFloat(Object parent, long offset)` Resets to 0.0f the float value at the given offset of the supplied parent object
`void`	`putDefaultInt(Object parent, long offset)` Resets to 0 the int value at the given offset of the supplied parent object
`void`	`putDefaultLong(Object parent, long offset)` Resets to 0 the long value at the given offset of the supplied parent object
`void`	`putDefaultShort(Object parent, long offset)` Resets to 0 the short value at the given offset of the supplied parent object
`void`	`putDouble(Object parent, long offset, double value)` Puts the value at the given offset of the supplied parent object
`void`	`putFloat(Object parent, long offset, float value)` Puts the value at the given offset of the supplied parent object
`void`	`putInt(Object parent, long offset, int value)` Puts the value at the given offset of the supplied parent object
`void`	`putLong(Object parent, long offset, long value)` Puts the value at the given offset of the supplied parent object
`void`	`putNullObject(Object parent, long offset)` Write a null value to the given offset of the supplied parent object
`void`	`putObject(Object parent, long offset, Object value)` Puts the object's reference at the given offset of the supplied parent object
`void`	`putPrimitiveDefaultAtOffset(Object copy, Class<?> type, long offset)` Restores the primitive at the given field to its default value.
`void`	`putShort(Object parent, long offset, short value)` Puts the value at the given offset of the supplied parent object
`<T> T`	`shallowCopy(T obj)` Performs a shallow copy of the given object - a new instance is allocated with the same contents.
`long`	`shallowSizeOf(Class<?> clazz)` Determines the shallow memory size of an instance of the given class
`long`	`shallowSizeOf(Object obj)` Determines the shallow memory size of the given object (object or array)
`long`	`toAddress(Object obj)` Convert the object reference to a memory address represented as a signed long

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getUnsafeOperations
```
public static final UnsafeOperations getUnsafeOperations()
```
    Returns the (singleton) UnsafeOperations instance
    
    Returns:
    
    UnsafeOperations
  - isUnsafeAvailable
```
public static boolean isUnsafeAvailable()
```
    Check whether the Unsafe API is accessible
    
    Returns:
    
    True if available
  - allocateInstance
```
public final <T> T allocateInstance(Class<T> clazz)
                             throws IllegalStateException
```
    Construct and allocate on the heap an instant of the given class, without calling the class constructor
    
    Type Parameters:
    
    T - Type of the instance to be constructed
    
    Parameters:
    
    clazz - Class to create instant for
    
    Returns:
    
    The new instance
    
    Throws:
    
    IllegalStateException - Indicates a problem occurred
  - getObjectFieldOffset
```
public final long getObjectFieldOffset(Field f)
```
    Gets an offset for the given field relative to the field base. Any particular field will always have the same offset, and no two distinct fields of the same class will ever have the same offset.
    
    Parameters:
    
    f - The Field to determine the offset for
    
    Returns:
    
    The offset represented as a long
  - shallowCopy
```
public final <T> T shallowCopy(T obj)
```
    Performs a shallow copy of the given object - a new instance is allocated with the same contents. Any object references inside the copy will be the same as the original object.
    
    Type Parameters:
    
    T - The type being copied
    
    Parameters:
    
    obj - Object to copy
    
    Returns:
    
    A new instance, identical to the original
  - toAddress
```
public final long toAddress(Object obj)
```
    Convert the object reference to a memory address represented as a signed long
    
    Parameters:
    
    obj - The object
    
    Returns:
    
    A long representing the address of the object
  - fromAddress
```
public final Object fromAddress(long address)
```
    Returns the object located at the given memory address
    
    Parameters:
    
    address - The address (a signed long) for the object
    
    Returns:
    
    The Object at the given address
  - copyPrimitiveField
```
public final void copyPrimitiveField(Object source,
                                     Object copy,
                                     Field field)
```
    Copy the value from the given field from the source into the target. The field specified must contain a primitive
    
    Parameters:
    
    source - The object to copy from
    
    copy - The target object
    
    field - Field to be copied
  - copyPrimitiveAtOffset
```
public final void copyPrimitiveAtOffset(Object source,
                                        Object copy,
                                        Class<?> type,
                                        long offset)
```
    Copies the primitive of the specified type from the given field offset in the source object to the same location in the copy
    
    Parameters:
    
    source - The object to copy from
    
    copy - The target object
    
    type - The type of primitive at the given offset - e.g. java.lang.Boolean.TYPE
    
    offset - The offset to copy from
  - putPrimitiveDefaultAtOffset
```
public final void putPrimitiveDefaultAtOffset(Object copy,
                                              Class<?> type,
                                              long offset)
```
    Restores the primitive at the given field to its default value. Default value is defined as the value that the field would hold if it was a new, uninitialised value (e.g. false for a boolean).
    
    Parameters:
    
    copy - The target object
    
    type - The type of primitive at the given offset - e.g. java.lang.Boolean.TYPE
    
    offset - The offset to reset to its default value
  - deepCopy
```
public <T> T deepCopy(T obj)
```
    Performs a deep copy of the object. With a deep copy all references from the object are also copied. The identity of referenced objects is preserved, so, for example, if the object graph contains two references to the same object, the cloned object will preserve this structure.
    
    Type Parameters:
    
    T - The type being copied
    
    Parameters:
    
    obj - The object to perform a deep copy for.
    
    Returns:
    
    A deep copy of the original object.
  - deepCopy
```
public <T> T deepCopy(T o,
                      IdentityHashMap<Object,Object> referencesToReuse)
```
    Performs a deep copy of the object. With a deep copy all references from the object are also copied. The identity of referenced objects is preserved, so, for example, if the object graph contains two references to the same object, the cloned object will preserve this structure.
    
    Type Parameters:
    
    T - The type being copied
    
    Parameters:
    
    o - The object to perform a deep copy for.
    
    referencesToReuse - An identity map of references to reuse - this is further populated as the copy progresses. The key is the original object reference - the value is the copied instance for that original.
    
    Returns:
    
    A deep copy of the original object.
  - deepCopyObjectAtOffset
```
public final void deepCopyObjectAtOffset(Object source,
                                         Object copy,
                                         Class<?> fieldClass,
                                         long offset)
```
    Copies the object of the specified type from the given field offset in the source object to the same location in the copy, visiting the object during the copy so that its fields are also copied
    
    Parameters:
    
    source - The object to copy from
    
    copy - The target object
    
    fieldClass - The declared type of object at the given offset
    
    offset - The offset to copy from
  - deepCopyObjectAtOffset
```
public final void deepCopyObjectAtOffset(Object source,
                                         Object copy,
                                         Class<?> fieldClass,
                                         long offset,
                                         IdentityHashMap<Object,Object> referencesToReuse)
```
    Copies the object of the specified type from the given field offset in the source object to the same location in the copy, visiting the object during the copy so that its fields are also copied
    
    Parameters:
    
    source - The object to copy from
    
    copy - The target object
    
    fieldClass - The declared type of object at the given offset
    
    offset - The offset to copy from
    
    referencesToReuse - An identity map of references to reuse - this is further populated as the copy progresses. The key is the original object reference - the value is the copied instance for that original.
  - deepCopyObjectField
```
public final void deepCopyObjectField(Object source,
                                      Object copy,
                                      Field field,
                                      IdentityHashMap<Object,Object> referencesToReuse)
```
    Copies the object of the specified type from the given field in the source object to the same field in the copy, visiting the object during the copy so that its fields are also copied
    
    Parameters:
    
    source - The object to copy from
    
    copy - The target object
    
    field - Field to be copied
    
    referencesToReuse - An identity map of references to reuse - this is further populated as the copy progresses. The key is the original object reference - the value is the copied instance for that original.
  - deepCopyObjectField
```
public final void deepCopyObjectField(Object obj,
                                      Object copy,
                                      Field field)
```
    Copies the object of the specified type from the given field in the source object to the same field in the copy, visiting the object during the copy so that its fields are also copied
    
    Parameters:
    
    obj - The object to copy from
    
    copy - The target object
    
    field - Field to be copied
  - deepCopyArrayAtOffset
```
public final void deepCopyArrayAtOffset(Object source,
                                        Object copy,
                                        Class<?> fieldClass,
                                        long offset)
```
    Copies the array of the specified type from the given field offset in the source object to the same location in the copy, visiting the array during the copy so that its contents are also copied
    
    Parameters:
    
    source - The object to copy from
    
    copy - The target object
    
    fieldClass - The declared type of array at the given offset
    
    offset - The offset to copy from
  - deepCopyArrayAtOffset
```
public final void deepCopyArrayAtOffset(Object source,
                                        Object copy,
                                        Class<?> fieldClass,
                                        long offset,
                                        IdentityHashMap<Object,Object> referencesToReuse)
```
    Copies the array of the specified type from the given field offset in the source object to the same location in the copy, visiting the array during the copy so that its contents are also copied
    
    Parameters:
    
    source - The object to copy from
    
    copy - The target object
    
    fieldClass - The declared type of array at the given offset
    
    offset - The offset to copy from
    
    referencesToReuse - An identity map of references to reuse - this is further populated as the copy progresses. The key is the original object reference - the value is the copied instance for that original.
  - deepCopyArrayField
```
public final void deepCopyArrayField(Object obj,
                                     Object copy,
                                     Field field,
                                     IdentityHashMap<Object,Object> referencesToReuse)
```
    Copies the array of the specified type from the given field in the source object to the same field in the copy, visiting the array during the copy so that its contents are also copied
    
    Parameters:
    
    obj - The object to copy from
    
    copy - The target object
    
    field - Field to be copied
    
    referencesToReuse - An identity map of references to reuse - this is further populated as the copy progresses. The key is the original object reference - the value is the copied instance for that original.
  - deepCopyArrayField
```
public final void deepCopyArrayField(Object obj,
                                     Object copy,
                                     Field field)
```
    Copies the array of the specified type from the given field in the source object to the same field in the copy, visiting the array during the copy so that its contents are also copied
    
    Parameters:
    
    obj - The object to copy from
    
    copy - The target object
    
    field - Field to be copied
  - deepCopyArray
```
public final Object deepCopyArray(Object arrayOriginal,
                                  IdentityHashMap<Object,Object> visited)
```
    Performs a deep copy of the array. With a deep copy all references from the array are also copied. The identity of referenced objects is preserved, so, for example, if the object graph contains two references to the same object, the cloned object will preserve this structure.
    
    Parameters:
    
    arrayOriginal - The array to perform a deep copy for.
    
    visited - An identity map of references to reuse - this is further populated as the copy progresses. The key is the original object reference - the value is the copied instance for that original.
    
    Returns:
    
    A deep copy of the original array.
  - shallowSizeOf
```
public final long shallowSizeOf(Class<?> clazz)
```
    Determines the shallow memory size of an instance of the given class
    
    Parameters:
    
    clazz - The class to calculate the shallow size for
    
    Returns:
    
    Size in bytes
  - shallowSizeOf
```
public final long shallowSizeOf(Object obj)
```
    Determines the shallow memory size of the given object (object or array)
    
    Parameters:
    
    obj - The object instance to calculate the shallow size for
    
    Returns:
    
    Size in bytes
  - deepSizeOf
```
public final long deepSizeOf(Object o)
```
    Determines the deep memory size of the given object (object or array), visiting all its references
    
    Parameters:
    
    o - The object instance to calculate the deep size for
    
    Returns:
    
    Size in bytes
  - getAddressSize
```
public final int getAddressSize()
```
    Get the size in bytes of a native pointer - either 4 or 8 (for 32-bit or 64-bit JRE). For primitive types, the size is determined by their data type rather than this value.
    
    Returns:
    
    The address size
  - getObject
```
public final Object getObject(Object parent,
                              long offset)
```
    Retrieve the object at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    Returns:
    
    The retrieved object
  - getBoolean
```
public final boolean getBoolean(Object parent,
                                long offset)
```
    Retrieve the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    Returns:
    
    The retrieved boolean
  - getChar
```
public final char getChar(Object parent,
                          long offset)
```
    Retrieve the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    Returns:
    
    The retrieved char
  - getShort
```
public final short getShort(Object parent,
                            long offset)
```
    Retrieve the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    Returns:
    
    The retrieved short
  - getInt
```
public final int getInt(Object parent,
                        long offset)
```
    Retrieve the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    Returns:
    
    The retrieved int
  - getLong
```
public final long getLong(Object parent,
                          long offset)
```
    Retrieve the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    Returns:
    
    The retrieved long
  - getFloat
```
public final float getFloat(Object parent,
                            long offset)
```
    Retrieve the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    Returns:
    
    The retrieved float
  - getDouble
```
public final double getDouble(Object parent,
                              long offset)
```
    Retrieve the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    Returns:
    
    The retrieved double
  - getByte
```
public final byte getByte(Object parent,
                          long offset)
```
    Retrieve the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    Returns:
    
    The retrieved byte
  - putNullObject
```
public final void putNullObject(Object parent,
                                long offset)
```
    Write a null value to the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
  - putDefaultBoolean
```
public final void putDefaultBoolean(Object parent,
                                    long offset)
```
    Resets to false the boolean value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
  - putDefaultChar
```
public final void putDefaultChar(Object parent,
                                 long offset)
```
    Resets to u0000 the char value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
  - putDefaultShort
```
public final void putDefaultShort(Object parent,
                                  long offset)
```
    Resets to 0 the short value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
  - putDefaultInt
```
public final void putDefaultInt(Object parent,
                                long offset)
```
    Resets to 0 the int value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
  - putDefaultLong
```
public final void putDefaultLong(Object parent,
                                 long offset)
```
    Resets to 0 the long value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
  - putDefaultFloat
```
public final void putDefaultFloat(Object parent,
                                  long offset)
```
    Resets to 0.0f the float value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
  - putDefaultDouble
```
public final void putDefaultDouble(Object parent,
                                   long offset)
```
    Resets to 0.0d the double value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
  - putDefaultByte
```
public final void putDefaultByte(Object parent,
                                 long offset)
```
    Resets to 0 the byte value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
  - putObject
```
public final void putObject(Object parent,
                            long offset,
                            Object value)
```
    Puts the object's reference at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    value - Object to be put
  - putBoolean
```
public final void putBoolean(Object parent,
                             long offset,
                             boolean value)
```
    Puts the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    value - boolean to be put
  - putChar
```
public final void putChar(Object parent,
                          long offset,
                          char value)
```
    Puts the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    value - char to be put
  - putShort
```
public final void putShort(Object parent,
                           long offset,
                           short value)
```
    Puts the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    value - short to be put
  - putInt
```
public final void putInt(Object parent,
                         long offset,
                         int value)
```
    Puts the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    value - int to be put
  - putLong
```
public final void putLong(Object parent,
                          long offset,
                          long value)
```
    Puts the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    value - long to be put
  - putFloat
```
public final void putFloat(Object parent,
                           long offset,
                           float value)
```
    Puts the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    value - float to be put
  - putDouble
```
public final void putDouble(Object parent,
                            long offset,
                            double value)
```
    Puts the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    value - double to be put
  - putByte
```
public final void putByte(Object parent,
                          long offset,
                          byte value)
```
    Puts the value at the given offset of the supplied parent object
    
    Parameters:
    
    parent - The Object's parent
    
    offset - The offset
    
    value - byte to be put

Class UnsafeOperations

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getUnsafeOperations

isUnsafeAvailable

allocateInstance

getObjectFieldOffset

shallowCopy

toAddress

fromAddress

copyPrimitiveField

copyPrimitiveAtOffset

putPrimitiveDefaultAtOffset

deepCopy

deepCopy

deepCopyObjectAtOffset

deepCopyObjectAtOffset

deepCopyObjectField

deepCopyObjectField

deepCopyArrayAtOffset

deepCopyArrayAtOffset

deepCopyArrayField

deepCopyArrayField

deepCopyArray

shallowSizeOf

shallowSizeOf

deepSizeOf

getAddressSize

getObject

getBoolean

getChar

getShort

getInt

getLong

getFloat

getDouble

getByte

putNullObject

putDefaultBoolean

putDefaultChar

putDefaultShort

putDefaultInt

putDefaultLong

putDefaultFloat

putDefaultDouble

putDefaultByte

putObject

putBoolean

putChar

putShort

putInt

putLong

putFloat

putDouble

putByte