com.atlassian.jira.plugin.userformat
Interface UserFormatter

All Known Implementing Classes:

UserFormatterImpl

@PublicApi
public interface UserFormatter

Since:

v6.0

Method Summary

String	formatUserkey(String userkey, String id) Renders the formatted user for a given section on the screen.
String	formatUserkey(String userkey, String id, Map<String,Object> params) 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.

Method Detail

formatUserkey

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

formatUserkey

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

formatUsername

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

formatUsername

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