com.atlassian.jira.plugin.userformat

Class UserNameUserFormat

java.lang.Object

com.atlassian.jira.plugin.userformat.UserNameUserFormat

All Implemented Interfaces:

UserFormat

public class UserNameUserFormat
extends Object
implements UserFormat

Very simple implementation that only renders the user's username.

Since:

v5.0.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Fields inherited from interface com.atlassian.jira.plugin.profile.UserFormat

VIEW_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
UserNameUserFormat(UserManager userManager)

Method Summary

Modifier and Type	Method and Description
String	format(String key, String id) Renders the formatted user for a given section on the screen.
String	format(String key, 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

UserNameUserFormat

public UserNameUserFormat(UserManager userManager)

Method Detail

format

public String format(String key,
                     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:

key - the user's userkey to format.

id - A value providing extra context to the rendering process.

Returns:

the formatted user

format

public String format(String key,
                     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:

key - the user's userkey to format.

id - A value providing extra context to the rendering process.

params - Additional context to pass to the renderer

Returns:

the formatted user