org.apache.jackrabbit.core.observation
Class EventState

java.lang.Object
  org.apache.jackrabbit.core.observation.EventState

public class EventState
extends java.lang.Object

The EventState class encapsulates the session independent state of an Event.

Method Summary

static EventState	childNodeAdded(NodeId parentId, Path parentPath, NodeId childId, Path.Element childPath, Name nodeType, java.util.Set mixins, javax.jcr.Session session) Creates a new Event of type Event.NODE_ADDED.
static EventState	childNodeAdded(NodeId parentId, Path parentPath, NodeId childId, Path.Element childPath, Name nodeType, java.util.Set mixins, javax.jcr.Session session, boolean external) Creates a new Event of type Event.NODE_ADDED.
static EventState	childNodeRemoved(NodeId parentId, Path parentPath, NodeId childId, Path.Element childPath, Name nodeType, java.util.Set mixins, javax.jcr.Session session) Creates a new Event of type Event.NODE_REMOVED.
static EventState	childNodeRemoved(NodeId parentId, Path parentPath, NodeId childId, Path.Element childPath, Name nodeType, java.util.Set mixins, javax.jcr.Session session, boolean external) Creates a new Event of type Event.NODE_REMOVED.
boolean	equals(java.lang.Object obj) Returns true if this EventState is equal to another object.
NodeId	getChildId() Returns the Id of a child node operation.
Path.Element	getChildRelPath() Returns the relative Path of the child Item associated with this event.
java.util.Set	getMixinNames() Returns a set of Names which are the names of the mixins assigned to the parent node associated with this event.
Name	getNodeType() Returns the node type of the parent node associated with this event.
java.util.Set	getNodeTypes(NodeTypeManagerImpl ntMgr) Returns the Set of NodeTypes assigned to the parent node associated with this event.
NodeId	getParentId() Returns the uuid of the parent node.
Path	getParentPath() Returns the path of the parent node.
int	getType()
java.lang.String	getUserId()
int	hashCode() Returns a hashCode for this EventState.
static EventState	propertyAdded(NodeId parentId, Path parentPath, Path.Element childPath, Name nodeType, java.util.Set mixins, javax.jcr.Session session) Creates a new Event of type Event.PROPERTY_ADDED.
static EventState	propertyAdded(NodeId parentId, Path parentPath, Path.Element childPath, Name nodeType, java.util.Set mixins, javax.jcr.Session session, boolean external) Creates a new Event of type Event.PROPERTY_ADDED.
static EventState	propertyChanged(NodeId parentId, Path parentPath, Path.Element childPath, Name nodeType, java.util.Set mixins, javax.jcr.Session session) Creates a new Event of type Event.PROPERTY_CHANGED.
static EventState	propertyChanged(NodeId parentId, Path parentPath, Path.Element childPath, Name nodeType, java.util.Set mixins, javax.jcr.Session session, boolean external) Creates a new Event of type Event.PROPERTY_CHANGED.
static EventState	propertyRemoved(NodeId parentId, Path parentPath, Path.Element childPath, Name nodeType, java.util.Set mixins, javax.jcr.Session session) Creates a new Event of type Event.PROPERTY_REMOVED.
static EventState	propertyRemoved(NodeId parentId, Path parentPath, Path.Element childPath, Name nodeType, java.util.Set mixins, javax.jcr.Session session, boolean external) Creates a new Event of type Event.PROPERTY_REMOVED.
java.lang.String	toString() Returns a String representation of this EventState.
static java.lang.String	valueOf(int eventType) Returns a String representation of eventType.

Methods inherited from class java.lang.Object

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

Method Detail

childNodeAdded

public static EventState childNodeAdded(NodeId parentId,
                                        Path parentPath,
                                        NodeId childId,
                                        Path.Element childPath,
                                        Name nodeType,
                                        java.util.Set mixins,
                                        javax.jcr.Session session)

Creates a new Event of type Event.NODE_ADDED.

Parameters:

parentId - the id of the parent node associated with this EventState.

parentPath - the path of the parent node associated with this EventState.

childId - the id of the child node associated with this event.

childPath - the relative path of the child node that was added.

nodeType - the node type of the parent node.

mixins - mixins assigned to the parent node.

session - the session that added the node.

Returns:

an EventState instance.

childNodeAdded

public static EventState childNodeAdded(NodeId parentId,
                                        Path parentPath,
                                        NodeId childId,
                                        Path.Element childPath,
                                        Name nodeType,
                                        java.util.Set mixins,
                                        javax.jcr.Session session,
                                        boolean external)

Creates a new Event of type Event.NODE_ADDED.

Parameters:

parentId - the id of the parent node associated with this EventState.

parentPath - the path of the parent node associated with this EventState.

childId - the id of the child node associated with this event.

childPath - the relative path of the child node that was added.

nodeType - the node type of the parent node.

mixins - mixins assigned to the parent node.

session - the session that added the node.

external - flag indicating whether this is an external event

Returns:

an EventState instance.

childNodeRemoved

public static EventState childNodeRemoved(NodeId parentId,
                                          Path parentPath,
                                          NodeId childId,
                                          Path.Element childPath,
                                          Name nodeType,
                                          java.util.Set mixins,
                                          javax.jcr.Session session)

Creates a new Event of type Event.NODE_REMOVED.

Parameters:

parentId - the id of the parent node associated with this EventState.

parentPath - the path of the parent node associated with this EventState.

childId - the id of the child node associated with this event.

childPath - the relative path of the child node that was removed.

nodeType - the node type of the parent node.

mixins - mixins assigned to the parent node.

session - the session that removed the node.

Returns:

an EventState instance.

childNodeRemoved

public static EventState childNodeRemoved(NodeId parentId,
                                          Path parentPath,
                                          NodeId childId,
                                          Path.Element childPath,
                                          Name nodeType,
                                          java.util.Set mixins,
                                          javax.jcr.Session session,
                                          boolean external)

Creates a new Event of type Event.NODE_REMOVED.

Parameters:

parentId - the id of the parent node associated with this EventState.

parentPath - the path of the parent node associated with this EventState.

childId - the id of the child node associated with this event.

childPath - the relative path of the child node that was removed.

nodeType - the node type of the parent node.

mixins - mixins assigned to the parent node.

session - the session that removed the node.

external - flag indicating whether this is an external event

Returns:

an EventState instance.

propertyAdded

public static EventState propertyAdded(NodeId parentId,
                                       Path parentPath,
                                       Path.Element childPath,
                                       Name nodeType,
                                       java.util.Set mixins,
                                       javax.jcr.Session session)

Creates a new Event of type Event.PROPERTY_ADDED.

Parameters:

parentId - the id of the parent node associated with this EventState.

parentPath - the path of the parent node associated with this EventState.

childPath - the relative path of the property that was added.

nodeType - the node type of the parent node.

mixins - mixins assigned to the parent node.

session - the session that added the property.

Returns:

an EventState instance.

propertyAdded

public static EventState propertyAdded(NodeId parentId,
                                       Path parentPath,
                                       Path.Element childPath,
                                       Name nodeType,
                                       java.util.Set mixins,
                                       javax.jcr.Session session,
                                       boolean external)

Creates a new Event of type Event.PROPERTY_ADDED.

Parameters:

parentId - the id of the parent node associated with this EventState.

parentPath - the path of the parent node associated with this EventState.

childPath - the relative path of the property that was added.

nodeType - the node type of the parent node.

mixins - mixins assigned to the parent node.

session - the session that added the property.

external - flag indicating whether this is an external event

Returns:

an EventState instance.

propertyRemoved

public static EventState propertyRemoved(NodeId parentId,
                                         Path parentPath,
                                         Path.Element childPath,
                                         Name nodeType,
                                         java.util.Set mixins,
                                         javax.jcr.Session session)

Creates a new Event of type Event.PROPERTY_REMOVED.

Parameters:

parentId - the id of the parent node associated with this EventState.

parentPath - the path of the parent node associated with this EventState.

childPath - the relative path of the property that was removed.

nodeType - the node type of the parent node.

mixins - mixins assigned to the parent node.

session - the session that removed the property.

Returns:

an EventState instance.

propertyRemoved

public static EventState propertyRemoved(NodeId parentId,
                                         Path parentPath,
                                         Path.Element childPath,
                                         Name nodeType,
                                         java.util.Set mixins,
                                         javax.jcr.Session session,
                                         boolean external)

Creates a new Event of type Event.PROPERTY_REMOVED.

Parameters:

parentId - the id of the parent node associated with this EventState.

parentPath - the path of the parent node associated with this EventState.

childPath - the relative path of the property that was removed.

nodeType - the node type of the parent node.

mixins - mixins assigned to the parent node.

session - the session that removed the property.

external - flag indicating whether this is an external event

Returns:

an EventState instance.

propertyChanged

public static EventState propertyChanged(NodeId parentId,
                                         Path parentPath,
                                         Path.Element childPath,
                                         Name nodeType,
                                         java.util.Set mixins,
                                         javax.jcr.Session session)

Creates a new Event of type Event.PROPERTY_CHANGED.

Parameters:

parentId - the id of the parent node associated with this EventState.

parentPath - the path of the parent node associated with this EventState.

childPath - the relative path of the property that changed.

nodeType - the node type of the parent node.

mixins - mixins assigned to the parent node.

session - the session that changed the property.

Returns:

an EventState instance.

propertyChanged

public static EventState propertyChanged(NodeId parentId,
                                         Path parentPath,
                                         Path.Element childPath,
                                         Name nodeType,
                                         java.util.Set mixins,
                                         javax.jcr.Session session,
                                         boolean external)

Creates a new Event of type Event.PROPERTY_CHANGED.

Parameters:

parentId - the id of the parent node associated with this EventState.

parentPath - the path of the parent node associated with this EventState.

childPath - the relative path of the property that changed.

nodeType - the node type of the parent node.

mixins - mixins assigned to the parent node.

session - the session that changed the property.

external - flag indicating whether this is an external event

Returns:

an EventState instance.

getType

public int getType()

getParentId

public NodeId getParentId()

Returns the uuid of the parent node.

Returns:

the uuid of the parent node.

getParentPath

public Path getParentPath()

Returns the path of the parent node.

Returns:

the path of the parent node.

getChildId

public NodeId getChildId()

Returns the Id of a child node operation. If this EventState was generated for a property operation this method returns null.

Returns:

the id of a child node operation.

getChildRelPath

public Path.Element getChildRelPath()

Returns the relative Path of the child Item associated with this event.

Returns:

the Path.Element associated with this event.

getNodeType

public Name getNodeType()

Returns the node type of the parent node associated with this event.

Returns:

the node type of the parent associated with this event.

getMixinNames

public java.util.Set getMixinNames()

Returns a set of Names which are the names of the mixins assigned to the parent node associated with this event.

Returns:

the mixin names as Names.

getNodeTypes

public java.util.Set getNodeTypes(NodeTypeManagerImpl ntMgr)

Returns the Set of NodeTypes assigned to the parent node associated with this event. This Set includes the primary type as well as all the mixin types assigned to the parent node.

Returns:

Set of NodeTypes.

getUserId

public java.lang.String getUserId()

toString

public java.lang.String toString()

Returns a String representation of this EventState.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this EventState.

hashCode

public int hashCode()

Returns a hashCode for this EventState.

Overrides:

hashCode in class java.lang.Object

Returns:

a hashCode for this EventState.

equals

public boolean equals(java.lang.Object obj)

Returns true if this EventState is equal to another object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if object obj is equal to this EventState; false otherwise.

valueOf

public static java.lang.String valueOf(int eventType)

Returns a String representation of eventType.

Parameters:

eventType - an event type defined by Event.

Returns:

a String representation of eventType.