com.atlassian.jira.plugin.userformat
Class ProfileLinkUserFormat

java.lang.Object
  extended by com.atlassian.jira.plugin.userformat.ProfileLinkUserFormat
All Implemented Interfaces:
UserFormat

public class ProfileLinkUserFormat
extends Object
implements UserFormat

Very simple implementation that only renders the users full name with a link to the user's profile page. If the username is null, it will display 'Anonymous'. If no user matching the username can be found, ony the username will be printed.

Since:
v3.13

Field Summary
static String TYPE
           
 
Fields inherited from interface com.atlassian.jira.plugin.profile.UserFormat
VIEW_TEMPLATE
 
Constructor Summary
ProfileLinkUserFormat(UserFormatModuleDescriptor moduleDescriptor, UserUtil userUtil, AvatarService avatarService, JiraAuthenticationContext jiraAuthenticationContext)
           
 
Method Summary
 String format(String username, String id)
          Renders the formatted user for a given section on the screen.
 String format(String username, String id, Map<String,Object> params)
          Renders the formatted user for a given section on the screen.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE

public static final String TYPE
See Also:
Constant Field Values
Constructor Detail

ProfileLinkUserFormat

public ProfileLinkUserFormat(UserFormatModuleDescriptor moduleDescriptor,
                             UserUtil userUtil,
                             AvatarService avatarService,
                             JiraAuthenticationContext jiraAuthenticationContext)
Method Detail

format

public String format(String username,
                     String id)
Description copied from interface: UserFormat
Renders the formatted user for a given section on the screen. Please note that the username may be null (eg for empty fields, anonymous user's, etc) or the user may not exist. Implementations should handle these cases.

Extra context can be passed to the renderer via the id attribute. Ideally an implementation might include this id in the rendered output such that it can be used for test assertions.

The result should always be ready to display in an HTML response i.e. it should be HTML encoded if necessary.

Specified by:
format in interface UserFormat
Parameters:
username - the user's username to format.
id - A value providing extra context to the rendering process.
Returns:
the formatted user

format

public String format(String username,
                     String id,
                     Map<String,Object> params)
Description copied from interface: UserFormat
Renders the formatted user for a given section on the screen. Please note that the username may be null (eg for empty fields, anonymous user's, etc) or the user may not exist. Implementations should handle these cases.

Extra context can be passed to the renderer via the params attribute.

The result should always be ready to display in an HTML response i.e. it should be HTML encoded if necessary.

Specified by:
format in interface UserFormat
Parameters:
username - the user's username to format.
id - A value providing extra context to the rendering process.
params - Additional context to pass to the renderer
Returns:
the formatted user


Copyright © 2002-2012 Atlassian. All Rights Reserved.