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

Class PageChildrenReorderEvent

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.PageChildrenReorderEvent

All Implemented Interfaces:

Contented, Timestamped, Updated, Serializable

public class PageChildrenReorderEvent
extends PageEvent
implements Updated

An event where a page's children are re-ordered. No children are added or removed as part of the event, they only change position in the children list.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
PageChildrenReorderEvent(Object src, Page parentPage, List<Page> oldSortedChildren, List<Page> newSortedChildren, @Nullable com.atlassian.user.User user)

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)	Equals for ConfluenceEvents is defined such that specific sub-events are only equal to events of the same type.
@NonNull List<Page>	getNewSortedChildPages()
@NonNull List<Page>	getOldSortedChildPages()
@Nullable com.atlassian.user.User	getUser()
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

PageChildrenReorderEvent

public PageChildrenReorderEvent(Object src,
                                Page parentPage,
                                List<Page> oldSortedChildren,
                                List<Page> newSortedChildren,
                                @Nullable com.atlassian.user.User user)

Parameters:

src - the object that performed the move

parentPage - the page that has reordered children

oldSortedChildren - the ordered List of child pages before the reorder

newSortedChildren - the ordered List of child pages after the reorder

user - the user that moved the page. Can be null

Method Detail

getUser

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

Returns:

the user that moved the page

getOldSortedChildPages

public @NonNull List<Page> getOldSortedChildPages()

Returns:

the list of page children before the reorder

Since:

5.8

getNewSortedChildPages

public @NonNull List<Page> getNewSortedChildPages()

Returns:

the list of page children after the reorder

Since:

5.8

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