com.atlassian.confluence.content.render.xhtml.storage.link.user
Class DefaultUserMentionsExtractor

java.lang.Object
  extended by com.atlassian.confluence.content.render.xhtml.storage.link.user.DefaultUserMentionsExtractor
All Implemented Interfaces:
UserMentionsExtractor

public class DefaultUserMentionsExtractor
extends java.lang.Object
implements UserMentionsExtractor

For historical reasons, this class impelements both UserMentionsExtractor and InlineTaskUserExtractor.


Constructor Summary
DefaultUserMentionsExtractor(UserAccessor userAccessor, XmlEventReaderFactory readerFactory, java.util.List<? extends MentionsParser> delegates)
          Deprecated. since 5.3. The MentionsParser mechanism is deprecated with no replacement. Use #DefaultUserMentionsExtractor(com.atlassian.confluence.user.UserAccessor, com.atlassian.confluence.content.render.xhtml.XmlEventReaderFactory)
DefaultUserMentionsExtractor(UserAccessor userAccessor, XmlEventReaderFactory readerFactory, Unmarshaller<UserResourceIdentifier> userResourceIdentifierUnmarshaller)
           
 
Method Summary
 java.util.List<ConfluenceUser> extractMentionedUsers(javax.xml.stream.XMLEventReader reader)
          Given a stream of storage format extracts all user links that are considered a 'mention'.
 java.util.List<java.lang.String> extractUserMentions(javax.xml.stream.XMLEventReader reader)
          Deprecated. 
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultUserMentionsExtractor

@Deprecated
public DefaultUserMentionsExtractor(UserAccessor userAccessor,
                                               XmlEventReaderFactory readerFactory,
                                               java.util.List<? extends MentionsParser> delegates)
Deprecated. since 5.3. The MentionsParser mechanism is deprecated with no replacement. Use #DefaultUserMentionsExtractor(com.atlassian.confluence.user.UserAccessor, com.atlassian.confluence.content.render.xhtml.XmlEventReaderFactory)


DefaultUserMentionsExtractor

public DefaultUserMentionsExtractor(UserAccessor userAccessor,
                                    XmlEventReaderFactory readerFactory,
                                    Unmarshaller<UserResourceIdentifier> userResourceIdentifierUnmarshaller)
Method Detail

extractUserMentions

@Deprecated
public java.util.List<java.lang.String> extractUserMentions(javax.xml.stream.XMLEventReader reader)
                                                     throws javax.xml.stream.XMLStreamException
Deprecated. 

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).

Specified by:
extractUserMentions in interface UserMentionsExtractor
Parameters:
reader - reader of a storage format.
Returns:
the list of usernames of mentioned users.
Throws:
javax.xml.stream.XMLStreamException

extractMentionedUsers

public java.util.List<ConfluenceUser> extractMentionedUsers(javax.xml.stream.XMLEventReader reader)
                                                     throws javax.xml.stream.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).

Specified by:
extractMentionedUsers in interface UserMentionsExtractor
Parameters:
reader - reader of a storage format.
Returns:
the list of usernames of mentioned users.
Throws:
javax.xml.stream.XMLStreamException


Copyright © 2003-2013 Atlassian. All Rights Reserved.