com.atlassian.confluence.event.events.follow

Class FollowEvent

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.follow.FollowEvent

All Implemented Interfaces:

UserDriven, Serializable

public class FollowEvent
extends ConfluenceEvent
implements UserDriven

An event fired when a user is followed/

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
FollowEvent(Object src, ConfluenceUser followee, ConfluenceUser follower)
FollowEvent(Object src, com.atlassian.user.User subject, com.atlassian.user.User follower) Deprecated. since 5.2

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.
ConfluenceUser	getFolloweeUser()
com.atlassian.user.User	getFollower() Deprecated. since 5.2. Use getFollowerUser() instead.
ConfluenceUser	getFollowerUser()
com.atlassian.user.User	getOriginatingUser() Return the user that generated the event if known.
com.atlassian.user.User	getSubject() Deprecated. since 5.2. Use getFolloweeUser() instead.
int	hashCode() Subclasses must override this to hash their own fields.
String	toString()

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

Constructor Detail

FollowEvent

public FollowEvent(Object src,
                   ConfluenceUser followee,
                   ConfluenceUser follower)

Parameters:

src - the source of the event

followee - the user who is now being followed by 'follower'

follower - the user who is now following another user

Since:

5.2

FollowEvent

@Deprecated
public FollowEvent(Object src,
                               com.atlassian.user.User subject,
                               com.atlassian.user.User follower)

Deprecated. since 5.2

Parameters:

src - the source of the event

subject - the user who is now being followed by 'follower'

follower - the user who is now following another user

Method Detail

getFollowerUser

public ConfluenceUser getFollowerUser()

Since:

5.2

getFollower

@Deprecated
public com.atlassian.user.User getFollower()

Deprecated. since 5.2. Use getFollowerUser() instead.

getFolloweeUser

public ConfluenceUser getFolloweeUser()

Since:

5.2

getSubject

@Deprecated
public com.atlassian.user.User getSubject()

Deprecated. since 5.2. Use getFolloweeUser() instead.

getOriginatingUser

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.

equals

public boolean equals(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 ConfluenceEvent

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 ConfluenceEvent

Returns:

the hashcode

See Also:

Event.hashCode()

toString

public String toString()

Overrides:

toString in class EventObject