Package org.xwiki.mentions
Interface MentionsFormatter
-
@Role public interface MentionsFormatter
Provides services to format the user mentions.Unless you know statically the type of actor to format,
MentionFormatterProvider
should be used to resolve the formatter to use according to the type of the actor.- Since:
- 12.10
- Version:
- $Id: a6011f476c202ebfd85c244bafd59e75dd7a2169 $
- See Also:
MentionFormatterProvider
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
formatMention(String actorReference, DisplayStyle style)
Format a actor mention.
-
-
-
Method Detail
-
formatMention
String formatMention(String actorReference, DisplayStyle style)
Format a actor mention.The formatter takes the serialized reference of an actor and returns an user readable string. The kind of actor handled is specific to a
MentionFormatter
implementation.- Parameters:
actorReference
- the actor referencestyle
- the display style of the mention- Returns:
- the formatted mention
-
-