com.atlassian.confluence.event.events.content.pagehierarchy

Class AbstractPageHierarchyEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

com.atlassian.event.Event

com.atlassian.confluence.event.events.ConfluenceEvent

com.atlassian.confluence.event.events.content.ContentEvent

com.atlassian.confluence.event.events.content.page.PageEvent

com.atlassian.confluence.event.events.content.pagehierarchy.AbstractPageHierarchyEvent

All Implemented Interfaces:

Contented, Timestamped, Serializable

Direct Known Subclasses:

AbstractCopyPageHierarchyEvent, DeletePageHierarchyFinishEvent, DeletePageHierarchyStartEvent

public abstract class AbstractPageHierarchyEvent
extends PageEvent

TODO: Document this class / interface here

Since:

6.0.0

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AbstractPageHierarchyEvent(Object source, Page page, @Nullable ConfluenceUser initiator, boolean suppressNotifications) Deprecated. since 7.5, please use AbstractPageHierarchyEvent(Object, Page, ConfluenceUser, boolean, int) instead.
AbstractPageHierarchyEvent(Object source, Page page, @Nullable ConfluenceUser initiator, boolean suppressNotifications, int hierarchySize)

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable Object other) Equals for ConfluenceEvents is defined such that specific sub-events are only equal to events of the same type.
int	getHierarchySize() Returns the number of pages in the hierarchy involved in the action that triggered this event
Optional<ConfluenceUser>	getInitiator()
Page	getTargetPage()
int	hashCode() Subclasses must override this to hash their own fields.

Methods inherited from class com.atlassian.confluence.event.events.content.page.PageEvent

getContent, getPage, toString

Methods inherited from class com.atlassian.confluence.event.events.content.ContentEvent

isSuppressNotifications, setSuppressNotifications

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.event.events.Timestamped

getTimestamp

Constructor Detail

AbstractPageHierarchyEvent

@Deprecated
public AbstractPageHierarchyEvent(Object source,
                                              Page page,
                                              @Nullable ConfluenceUser initiator,
                                              boolean suppressNotifications)

Deprecated. since 7.5, please use AbstractPageHierarchyEvent(Object, Page, ConfluenceUser, boolean, int) instead.

AbstractPageHierarchyEvent

public AbstractPageHierarchyEvent(Object source,
                                  Page page,
                                  @Nullable ConfluenceUser initiator,
                                  boolean suppressNotifications,
                                  int hierarchySize)

Since:

7.5

Method Detail

getInitiator

public Optional<ConfluenceUser> getInitiator()

getHierarchySize

public int getHierarchySize()

Returns the number of pages in the hierarchy involved in the action that triggered this event

Since:

7.5

equals

public boolean equals(@Nullable Object other)

Description copied from class: ConfluenceEvent

Equals for ConfluenceEvents is defined such that specific sub-events are only equal to events of the same type. It is incorrect to try to make an instance of a subclass equal to an instance of any of its superclasses.

Subclasses must override this to compare their own fields.

Overrides:

equals in class PageEvent

Parameters:

other - the object to compare.

Returns:

true, if the given object has the same runtime class as this object's runtime class, and the event sources are equal.

See Also:

Event.equals(Object)

hashCode

public int hashCode()

Description copied from class: ConfluenceEvent

Subclasses must override this to hash their own fields.

Overrides:

hashCode in class PageEvent

Returns:

the hashcode

See Also:

Event.hashCode()

getTargetPage

public Page getTargetPage()