org.xwiki.mentions.events

Class MentionEvent

java.lang.Object

org.xwiki.mentions.events.MentionEvent

All Implemented Interfaces:

RecordableEvent, TargetableEvent, org.xwiki.observation.event.Event

@Unstable
public class MentionEvent
extends Object
implements RecordableEvent, TargetableEvent

The mention event.

Since:

12.5RC1

Version:

$Id: c61ff920a172a72b03e8e027838c7325cebffc5f $

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_TYPE Name of the mention event.

Constructor Summary

Constructors

Constructor and Description
MentionEvent(Set<String> targets, MentionEventParams params) Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
MentionEventParams	getParams()
Set<String>	getTarget()
int	hashCode()
boolean	matches(Object otherEvent)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_TYPE

public static final String EVENT_TYPE

Name of the mention event.

See Also:

Constant Field Values

Constructor Detail

MentionEvent

public MentionEvent(Set<String> targets,
                    MentionEventParams params)

Default constructor.

Parameters:

targets - Mention target (single user or members of a group).

params - Additional mention parameters.

Method Detail

getTarget

public Set<String> getTarget()

Specified by:

getTarget in interface TargetableEvent

getParams

public MentionEventParams getParams()

Returns:

Additional mention parameters.

matches

public boolean matches(Object otherEvent)

Specified by:

matches in interface org.xwiki.observation.event.Event

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