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

Class PageMoveEvent

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.page.PageMoveEvent

All Implemented Interfaces:

Contented, Timestamped, Updated, UserDriven, Serializable

public class PageMoveEvent
extends PageEvent
implements Updated, UserDriven

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PageMoveEvent(Object src, Page movedPage, List<Page> movedPageList, Space oldSpace, Page oldParentPage, Integer oldPosition, com.atlassian.user.User theMover, boolean movedBecauseOfParent)
PageMoveEvent(Object src, Page movedPage, Space oldSpace, Page oldParentPage, Integer oldPosition, com.atlassian.user.User theMover) Deprecated. since 5.8. Use PageMoveEvent(Object, com.atlassian.confluence.pages.Page, java.util.List, com.atlassian.confluence.spaces.Space, com.atlassian.confluence.pages.Page, Integer, com.atlassian.user.User, boolean) instead
PageMoveEvent(Object src, Page movedPage, Space oldSpace, Page oldParentPage, Integer oldPosition, com.atlassian.user.User theMover, boolean movedBecauseOfParent) Deprecated. since 5.8. Use PageMoveEvent(Object, com.atlassian.confluence.pages.Page, java.util.List, com.atlassian.confluence.spaces.Space, com.atlassian.confluence.pages.Page, Integer, com.atlassian.user.User, boolean) instead

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Equals for ConfluenceEvents is defined such that specific sub-events are only equal to events of the same type.
List<Page>	getMovedPageList()
Page	getNewParentpage() Deprecated. since 5.8. Use getNewParentPage() instead.
Page	getNewParentPage()
Page	getOldParentPage()
Integer	getOldPosition() Returns the position in the sibling page list the source page was in previously.
Space	getOldSpace()
com.atlassian.user.User	getOriginatingUser() Return the user that generated the event if known.
com.atlassian.user.User	getUser()
int	hashCode() Subclasses must override this to hash their own fields.
boolean	hasMovedChildren()
boolean	isMovedBecauseOfParent()
boolean	isMovedSpace()
String	toString()

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

getContent, getPage

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

PageMoveEvent

@Deprecated
public PageMoveEvent(Object src,
                                 Page movedPage,
                                 @Nullable
                                 Space oldSpace,
                                 @Nullable
                                 Page oldParentPage,
                                 @Nullable
                                 Integer oldPosition,
                                 com.atlassian.user.User theMover)

Deprecated. since 5.8. Use PageMoveEvent(Object, com.atlassian.confluence.pages.Page, java.util.List, com.atlassian.confluence.spaces.Space, com.atlassian.confluence.pages.Page, Integer, com.atlassian.user.User, boolean) instead

Parameters:

src - the object that performed the move

movedPage - the page that has been moved

oldSpace - the space the page was in - may be null if oldParentPage exists

oldParentPage - the page's old parent - may be null if the page was top level in a space

oldPosition - the page's old position if in an ordered list of siblings, else null

theMover - the user that moved the page - may be null if the user is anonymous

PageMoveEvent

@Deprecated
public PageMoveEvent(Object src,
                                 Page movedPage,
                                 @Nullable
                                 Space oldSpace,
                                 @Nullable
                                 Page oldParentPage,
                                 @Nullable
                                 Integer oldPosition,
                                 @Nullable
                                 com.atlassian.user.User theMover,
                                 boolean movedBecauseOfParent)

Deprecated. since 5.8. Use PageMoveEvent(Object, com.atlassian.confluence.pages.Page, java.util.List, com.atlassian.confluence.spaces.Space, com.atlassian.confluence.pages.Page, Integer, com.atlassian.user.User, boolean) instead

Parameters:

src - the object that performed the move

movedPage - the page that has been moved

oldSpace - the space the page was in - may be null if oldParentPage exists

oldParentPage - the page's old parent - may be null if the page was top level in a space

oldPosition - the page's old position if in an ordered list of siblings, else null

theMover - the user that moved the page - may be null if the user is anonymous

movedBecauseOfParent - true if this page was moved as a result of its parent page being moved

PageMoveEvent

public PageMoveEvent(Object src,
                     Page movedPage,
                     List<Page> movedPageList,
                     @Nullable
                     Space oldSpace,
                     @Nullable
                     Page oldParentPage,
                     @Nullable
                     Integer oldPosition,
                     @Nullable
                     com.atlassian.user.User theMover,
                     boolean movedBecauseOfParent)

Parameters:

src - the object that performed the move

movedPage - the page that has been moved

oldSpace - the space the page was in - may be null if oldParentPage exists

oldParentPage - the page's old parent - may be null if the page was top level in a space

oldPosition - the page's old position if in an ordered list of siblings, else null

theMover - the user that moved the page

movedPageList - list of moved pages, used to check referrer/referring pages of source page are moved or not

Since:

5.5.1

Method Detail

getOldSpace

@Nonnull
public Space getOldSpace()

Returns:

the space the page was in - should never return null

getOldParentPage

@Nullable
public Page getOldParentPage()

Returns:

the page's old parent - may be null if the page was top level in a space

getOldPosition

@Nullable
public Integer getOldPosition()

Returns the position in the sibling page list the source page was in previously. Will be null if the page was not in a manually-ordered list.

getUser

@Nullable
public com.atlassian.user.User getUser()

Returns:

the user that moved the page

getNewParentpage

@Deprecated
 @Nullable
public Page getNewParentpage()

Deprecated. since 5.8. Use getNewParentPage() instead.

getNewParentPage

@Nullable
public Page getNewParentPage()

Since:

5.8

hasMovedChildren

public boolean hasMovedChildren()

isMovedBecauseOfParent

public boolean isMovedBecauseOfParent()

Returns:

true if this page was moved as a result of its parent page being moved

isMovedSpace

public boolean isMovedSpace()

Returns:

true if the page has moved space.

getOriginatingUser

@Nullable
public com.atlassian.user.User getOriginatingUser()

Description copied from interface: UserDriven

Return the user that generated the event if known.

Specified by:

getOriginatingUser in interface UserDriven

Returns:

User that drove an event. Null indicates either that the event was driven by the anonymous user or the system itself.

getMovedPageList

@Nullable
public List<Page> getMovedPageList()

toString

public String toString()

Overrides:

toString in class PageEvent

equals

public boolean equals(@Nullable
                      Object obj)

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:

obj - 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()