org.modeshape.jcr.cache.change

Interface ChangeSet

All Superinterfaces:

Iterable<Change>, Serializable

All Known Implementing Classes:

RecordingChanges

public interface ChangeSet
extends Iterable<Change>, Serializable

Method Summary

Methods

Modifier and Type	Method and Description
Set<NodeKey>	changedNodes()
String	getProcessKey() Get the key of the process in which the changes were made.
String	getRepositoryKey() Get the key of the repository in which the changes were made.
String	getSessionId() Returns the ID of the session in which the changes occurred.
DateTime	getTimestamp()
Map<String,String>	getUserData()
String	getUserId()
String	getWorkspaceName() Get the name of the workspace in which the changes were made.
boolean	hasBinaryChanges() Checks if there are any binary changes in this change set.
boolean	isEmpty()
int	size() Return the number of individual changes.
Set<BinaryKey>	unusedBinaries() Returns the set of binary keys for those binary values which have become unused.
Set<BinaryKey>	usedBinaries() Returns the set of binary keys for those binary values which are being used.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

size

int size()

Return the number of individual changes.

Returns:

the number of changes

isEmpty

boolean isEmpty()

getUserId

String getUserId()

getUserData

Map<String,String> getUserData()

getTimestamp

DateTime getTimestamp()

getProcessKey

String getProcessKey()

Get the key of the process in which the changes were made.

Returns:

the process key; never null

getRepositoryKey

String getRepositoryKey()

Get the key of the repository in which the changes were made.

Returns:

the repository key; never null

getWorkspaceName

String getWorkspaceName()

Get the name of the workspace in which the changes were made.

Returns:

the workspace name; may be null only when workspaces are added or removed

changedNodes

Set<NodeKey> changedNodes()

unusedBinaries

Set<BinaryKey> unusedBinaries()

Returns the set of binary keys for those binary values which have become unused.

Returns:

the set of binary keys; never null;

usedBinaries

Set<BinaryKey> usedBinaries()

Returns the set of binary keys for those binary values which are being used.

Returns:

the set of binary keys; never null;

hasBinaryChanges

boolean hasBinaryChanges()

Checks if there are any binary changes in this change set.

Returns:

true if there are any binary changes (either values used or unused), false otherwise.

getSessionId

String getSessionId()

Returns the ID of the session in which the changes occurred.

Returns:

the id of a session, never null