com.atlassian.jira.plugin.profile
Class FullNameUserFormat

java.lang.Object
  extended by com.atlassian.jira.plugin.profile.FullNameUserFormat
All Implemented Interfaces:
UserFormat

public class FullNameUserFormat
extends Object
implements UserFormat

Very simple implementation that only renders the users full name.

Since:
v3.13

Field Summary
static String TYPE
           
 
Fields inherited from interface com.atlassian.jira.plugin.profile.UserFormat
VIEW_TEMPLATE
 
Constructor Summary
FullNameUserFormat(UserUtil userUtil)
           
 
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 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

FullNameUserFormat

public FullNameUserFormat(UserUtil userUtil)
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 (for anonymous user's) 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.

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 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 (for anonymous user's) or the user may not exist. Implementations should handle these cases.

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

Specified by:
format in interface UserFormat
Parameters:
username - the user's username to format.
params - Additional context to pass to the renderer
Returns:
the formatted user


Copyright © 2002-2008 Atlassian. All Rights Reserved.