public class

UserFormatterImpl

extends Object
implements UserFormatter
java.lang.Object
   ↳ com.atlassian.jira.plugin.userformat.UserFormatterImpl

Summary

Public Constructors
UserFormatterImpl(UserFormat userFormat, UserKeyService userKeyService)
Public Methods
String formatUserkey(String userkey, String id, Map<String, Object> params)
Renders the formatted user for a given section on the screen.
String formatUserkey(String userkey, String id)
Renders the formatted user for a given section on the screen.
String formatUsername(String username, String id)
Renders the formatted user for a given section on the screen.
String formatUsername(String username, String id, Map<String, Object> params)
Renders the formatted user for a given section on the screen.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.plugin.userformat.UserFormatter

Public Constructors

public UserFormatterImpl (UserFormat userFormat, UserKeyService userKeyService)

Public Methods

public String formatUserkey (String userkey, String id, Map<String, Object> params)

Renders the formatted user for a given section on the screen.

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

Parameters
userkey the user to format.
id A value providing extra context to the rendering process.
params Additional context to pass to the renderer
Returns
  • the formatted user

public String formatUserkey (String userkey, String id)

Renders the formatted user for a given section on the screen.

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

Parameters
userkey the user to format.
id A value providing extra context to the rendering process.
Returns
  • the formatted user

public String formatUsername (String username, String id)

Renders the formatted user for a given section on the screen.

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

Parameters
username the user to format.
id A value providing extra context to the rendering process.
Returns
  • the formatted user

public String formatUsername (String username, String id, Map<String, Object> params)

Renders the formatted user for a given section on the screen.

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

Parameters
username the user to format.
id A value providing extra context to the rendering process.
params Additional context to pass to the renderer
Returns
  • the formatted user