org.jsimpledb

Class CopyState

java.lang.Object

org.jsimpledb.CopyState

All Implemented Interfaces:

Cloneable

@NotThreadSafe
public class CopyState
extends Object
implements Cloneable

Keeps tracks of which objects have already been copied when copying objects between transactions.

Instances are not thread safe.

See Also:

JObject.copyTo(), JTransaction.copyTo()

Constructor Summary

Constructors

Constructor and Description
CopyState() Default constructor.
CopyState(ObjIdSet copied) Constructor to use when a set of known objects has already been copied.

Method Summary

Modifier and Type	Method and Description
CopyState	clone()
boolean	isCopied(ObjId id) Determine if an object has been marked as copied.
boolean	isSuppressNotifications() Determine whether to suppress @OnCreate and @OnChange notifications in the destination transaction.
boolean	markCopied(ObjId id) Determine if an object has already been copied, and if not mark it so.
boolean	markTraversed(ObjId id, int[] fields) Determine if the specified reference path has already been traversed starting at the given object, and if not mark it so.
void	setSuppressNotifications(boolean suppressNotifications) Configure whether to suppress @OnCreate and @OnChange notifications in the destination transaction.

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyState

public CopyState()

Default constructor.

CopyState

public CopyState(ObjIdSet copied)

Constructor to use when a set of known objects has already been copied.

Parameters:

copied - the ID's of objects that have already been copied

Throws:

IllegalArgumentException - if copied is null

Method Detail

markCopied

public boolean markCopied(ObjId id)

Determine if an object has already been copied, and if not mark it so.

Parameters:

id - object ID of object being copied

Returns:

true if id was not previously marked copied, otherwise false

Throws:

IllegalArgumentException - if id is null

isCopied

public boolean isCopied(ObjId id)

Determine if an object has been marked as copied.

Parameters:

id - object id

Returns:

true if id has been marked copied, otherwise false

Throws:

IllegalArgumentException - if id is null

isSuppressNotifications

public boolean isSuppressNotifications()

Determine whether to suppress @OnCreate and @OnChange notifications in the destination transaction.

Note that for notifications to be delivered in a SnapshotJTransaction, these annotations must also have snapshotTransactions = true, even if this property is set to false.

Returns:

true if @OnCreate and @OnChange notifications should be suppressed, otherwise false

setSuppressNotifications

public void setSuppressNotifications(boolean suppressNotifications)

Configure whether to suppress @OnCreate and @OnChange notifications in the destination transaction.

Note that for notifications to be delivered in a SnapshotJTransaction, these annotations must also have snapshotTransactions = true, even if this property is set to false.

Parameters:

suppressNotifications - true if @OnCreate and @OnChange notifications should be suppressed, otherwise false

markTraversed

public boolean markTraversed(ObjId id,
                             int[] fields)

Determine if the specified reference path has already been traversed starting at the given object, and if not mark it so.

Parameters:

id - object ID of object being copied

fields - reference path storage IDs

Returns:

true if fields was not previously marked as traversed from id, otherwise false

Throws:

IllegalArgumentException - if either parameter is null

IllegalArgumentException - if fields has length zero

clone

public CopyState clone()

Overrides:

clone in class Object