com.atlassian.confluence.event.events.follow
Class FollowEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.springframework.context.ApplicationEvent
          extended by com.atlassian.event.Event
              extended by com.atlassian.confluence.event.events.ConfluenceEvent
                  extended by com.atlassian.confluence.event.events.follow.FollowEvent
All Implemented Interfaces:
UserDriven, java.io.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
FollowEvent(java.lang.Object src, ConfluenceUser followee, ConfluenceUser follower)
           
FollowEvent(java.lang.Object src, com.atlassian.user.User subject, com.atlassian.user.User follower)
          Deprecated. since 5.2
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 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()
           
 java.lang.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(java.lang.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(java.lang.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(java.lang.Object obj)
Overrides:
equals in class com.atlassian.event.Event

hashCode

public int hashCode()
Overrides:
hashCode in class com.atlassian.event.Event

toString

public java.lang.String toString()
Overrides:
toString in class java.util.EventObject


Copyright © 2003-2014 Atlassian. All Rights Reserved.