Interface UserMentionsExtractor
-
- All Known Implementing Classes:
DefaultUserMentionsExtractor
public interface UserMentionsExtractor
The interface defines the mechanism for extracting mentions from a storage format. Not every link to a user is a mention - seeextractMentionedUsers(javax.xml.stream.XMLEventReader)
- Since:
- 4.3
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<ConfluenceUser>
extractMentionedUsers(XMLEventReader reader)
Given a stream of storage format extracts all user links that are considered a 'mention'.
-
-
-
Method Detail
-
extractMentionedUsers
List<ConfluenceUser> extractMentionedUsers(XMLEventReader reader) throws XMLStreamException
Given a stream of storage format extracts all user links that are considered a 'mention'. Not every link to a user is a mention e.g. the first link to a user inside an inline task is actually an assignee and should not be considered as a mention (because we deal with it differently).- Parameters:
reader
- reader of a storage format.- Returns:
- the list of usernames of mentioned users.
- Throws:
XMLStreamException
-
-