Package com.github.vfro

Class Sandbox<Entity extends Cloneable>

java.lang.Object

com.github.vfro.Sandbox<Entity>

Type Parameters:

Entity - monitored entity type.

All Implemented Interfaces:

Cloneable

public final class Sandbox<Entity extends Cloneable>
extends Object
implements Cloneable

`Sandbox` class allows threads to create a local copy of monitored entity and then Compare and Swap the mutated or changed entity back to monitor. The `Entity` must be `Cloneable` in order to create its local copy. `Sandbox` instance is not reentrant. Each thread must create a local instance of `Sandbox`.

Constructor Summary

Constructors

Constructor	Description
Sandbox()	Create a new instance of Sandbox with null as its monitored entity.
Sandbox(Monitor<Entity> monitor)	Create new instance of Sandbox and pull its entity from monitor.
Sandbox(Entity entity)	Create new instance of Sandbox with monitored entity.

Method Summary

Modifier and Type	Method	Description
boolean	casByReference(Monitor<Entity> monitor)	Compare monitored entity with the sandbox copy by reference and set it to monitor if the reference is the same.
boolean	casByValue(Monitor<Entity> monitor)	Compare monitored entity with the sandbox copy by value and set it to monitor if the reference is the same.
Sandbox<Entity>	clone()	Clone Sandbox.
boolean	equals(Object same)	Check if sandbox entity is equal to other`s sandbox entity.
Entity	get()	Access monitored entity.
int	hashCode()	Return hash code of sandbox entity.
Entity	pull(Monitor<Entity> monitor)	Access monitored entity in the monitor, assign its clone to sandbox and return the clone of obtained entity.
void	set(Entity entity)	Assign a new monitored entity to Sandbox.
String	toString()	Convert sandbox entity to string.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Sandbox

public Sandbox()

Create a new instance of Sandbox with null as its monitored entity.

Sandbox

public Sandbox(Entity entity)

Create new instance of Sandbox with monitored entity.

Parameters:

entity - monitored entity.

Sandbox

public Sandbox(Monitor<Entity> monitor)

Create new instance of Sandbox and pull its entity from monitor.

Parameters:

monitor - initial entity is pulled from the monitor.

See Also:

Monitor

Method Detail

get

public Entity get()

Access monitored entity. If the entity was previously pulled from Monitor then the copy of it is returned. The copy can be mutated without locking the monitor.

Returns:

monitored entity.

See Also:

set(java.lang.Cloneable)

set

public void set(Entity entity)

Assign a new monitored entity to Sandbox.

Parameters:

entity - monitored entity.

pull

public Entity pull(Monitor<Entity> monitor)

Access monitored entity in the monitor, assign its clone to sandbox and return the clone of obtained entity. Read access is used to obtain the entity. The entity is cloned before assigning it to sandbox, so later it could be mutated without locking the monitor.

Parameters:

monitor - the monitor to pull entity from.

Returns:

clone of monitored entity.

casByReference

public boolean casByReference(Monitor<Entity> monitor)

Compare monitored entity with the sandbox copy by reference and set it to monitor if the reference is the same.

Parameters:

monitor - the monitor to set the entity to.

Returns:

true if comparison was successful and entity was set to monitor, or false otherwise.

casByValue

public boolean casByValue(Monitor<Entity> monitor)

Compare monitored entity with the sandbox copy by value and set it to monitor if the reference is the same.

Parameters:

monitor - the monitor to set the entity to.

Returns:

true if comparison was successful and entity was set to monitor, or false otherwise.

toString

public String toString()

Convert sandbox entity to string.

Overrides:

toString in class Object

Returns:

String representation of sandbox entity.

equals

public boolean equals(Object same)

Check if sandbox entity is equal to other`s sandbox entity.

Overrides:

equals in class Object

Parameters:

same - the other sandbox.

Returns:

true if the entity in other sandbox is the same.

hashCode

public int hashCode()

Return hash code of sandbox entity.

Overrides:

hashCode in class Object

Returns:

hash code of sandbox entity.

clone

public Sandbox<Entity> clone()

Clone Sandbox.

Overrides:

clone in class Object

Returns:

New instance of Sandbox identical to this.