cern.entwined

Class STMUtils

java.lang.Object

cern.entwined.STMUtils

public abstract class STMUtils
extends Object

A set of methods aimed at facilitation of client's interactions with the transactional memory.

Author:

Ivan Koblik

Constructor Summary

Constructors

Constructor and Description
STMUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	dereference(GlobalReference<T> reference) Returns referenced value or null if the reference is null.
static <T extends SemiPersistent<T>> boolean	inTransaction(Memory<T> memory) Returns true if the current code is being executed within a transaction.
static <T> GlobalReference<T>	reference(Memory<?> memory, GlobalReference<T> globalReference, T value) Either updates the GlobalReference and returns it or, if the source is null, creates a new GlobalReference with the given value and returns it.

Methods inherited from class java.lang.Object

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

Constructor Detail

STMUtils

public STMUtils()

Method Detail

reference

public static <T> GlobalReference<T> reference(Memory<?> memory,
                               GlobalReference<T> globalReference,
                               T value)

Either updates the GlobalReference and returns it or, if the source is null, creates a new GlobalReference with the given value and returns it.

Type Parameters:

T - The referenced value type.

Parameters:

memory - The transactional memory.

globalReference - The global reference to be updated or null.

value - The value to be assigned.

Returns:

Either same GlobalReference as in the argument but with value changed or a new GlobalReference with the given value.

dereference

public static <T> T dereference(GlobalReference<T> reference)

Returns referenced value or null if the reference is null.

Type Parameters:

T - The referenced value type.

Parameters:

reference - The GlobalReference to dereference.

Returns:

The referenced value or null.

inTransaction

public static <T extends SemiPersistent<T>> boolean inTransaction(Memory<T> memory)

Returns true if the current code is being executed within a transaction.

Type Parameters:

T - The memory root type.

Parameters:

memory - The STM Memory instance.

Returns:

true if called from within a transaction.

Throws:

MemoryException - if this method is called from a committed block.