org.xwiki.mentions.events

Class MentionEventParams

java.lang.Object

org.xwiki.mentions.events.MentionEventParams

@Unstable
public class MentionEventParams
extends Object

The parameters of the mention event. This class is serialized to be retrieved for notifications rendering.

Since:

12.5RC1

Version:

$Id: 85d59f0bb30c696a6ea9d1e2d4bf3e5c90934f44 $

Constructor Summary

Constructors

Constructor and Description
MentionEventParams()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAnchor()
String	getDocumentReference()
MentionLocation	getLocation()
String	getQuote()
String	getUserReference()
int	hashCode()
MentionEventParams	setAnchor(String anchor)
MentionEventParams	setDocumentReference(String documentReference)
MentionEventParams	setLocation(MentionLocation location)
MentionEventParams	setQuote(String quote)
MentionEventParams	setUserReference(String userReference)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MentionEventParams

public MentionEventParams()

Method Detail

getUserReference

public String getUserReference()

Returns:

The the user doing the mention

setUserReference

public MentionEventParams setUserReference(String userReference)

Parameters:

userReference - the user doing the mention

Returns:

the current object

getDocumentReference

public String getDocumentReference()

Returns:

the document in which then mention occurs

setDocumentReference

public MentionEventParams setDocumentReference(String documentReference)

Parameters:

documentReference - the document in which then mention occurs

Returns:

the current object

getLocation

public MentionLocation getLocation()

Returns:

the location of the mention

setLocation

public MentionEventParams setLocation(MentionLocation location)

Parameters:

location - the location of the mention

Returns:

the current object

getAnchor

public String getAnchor()

Returns:

the anchor to be used for the link to the mention

setAnchor

public MentionEventParams setAnchor(String anchor)

Parameters:

anchor - the anchor to be used to link to the mention

Returns:

the current object

getQuote

public String getQuote()

Returns:

the mention quote

setQuote

public MentionEventParams setQuote(String quote)

Parameters:

quote - the mention quote

Returns:

the current object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object