io.goshawkdb.client

Class GoshawkObj

java.lang.Object

io.goshawkdb.client.GoshawkObj

public class GoshawkObj
extends java.lang.Object

Objects of this class represent nodes in the object graph stored by GoshawkDB. They can only be modified within a transaction.

Field Summary

Fields

Modifier and Type	Field and Description
VarUUId	id

Method Summary

Modifier and Type	Method and Description
GoshawkObj[]	getReferences() Get the objects pointed to from the current object.
java.nio.ByteBuffer	getValue() Returns the current value of this object.
TxnId	getVersion() Get the current version of the object.
void	set(java.nio.ByteBuffer value, GoshawkObj... references) Sets the value and references of the current object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

public final VarUUId id

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getValue

public java.nio.ByteBuffer getValue()

Returns the current value of this object.

Returns:

The current value. The returned buffer is a copy of the underlying buffer, so modifying it is perfectly safe. If you do modify it, you will need to call one of the set methods for your modifications to take any effect.

getReferences

public GoshawkObj[] getReferences()

Get the objects pointed to from the current object.

Returns:

the array of GoshawkObj to which the current object refers. As with getValue, the array is a copy of the underlying array, so you are safe to modify it, but you will need to call one of the set methods for your modifications to take any effect.

getVersion

public TxnId getVersion()

Get the current version of the object.

Returns:

the TxnId of the last transaction that wrote to this object. This will return null if the object has been created by the current transaction.

set

public void set(java.nio.ByteBuffer value,
                GoshawkObj... references)

Sets the value and references of the current object. If the value contains any references to other objects, they must be explicitly declared as references otherwise on retrieval you will not be able to navigate to them. Note that the order of references is stable. A null value sets the value to a zero-length ByteBuffer.

Parameters:

value - The value to set the object to. The buffer will be cloned and the contents copied. Therefore any changes you make to this param after calling this method will be ignored (you will need to call the set method again). The copying will not alter any position, limit, capacity or marks of the value ByteBuffer. The value is taken to be from position 0 to the current limit of the buffer.

references - The new list of objects to which the current object refers. Again, the array of references is copied.