Package com.atlassian.jira.plugin.userformat

Class UserFormatterImpl

java.lang.Object

com.atlassian.jira.plugin.userformat.UserFormatterImpl

All Implemented Interfaces:

UserFormatter

public class UserFormatterImpl
extends Object
implements UserFormatter

Since:

v6.0

Constructor Summary

Constructors

Constructor	Description
UserFormatterImpl(UserFormat userFormat, UserKeyService userKeyService)

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserFormatterImpl

public UserFormatterImpl(UserFormat userFormat,
 UserKeyService userKeyService)

Method Details

formatUserkey

public String formatUserkey(String userkey,
 String id)

Description copied from interface: UserFormatter

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.

Specified by:

formatUserkey in interface UserFormatter

Parameters:

userkey - the user to format.

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

Returns:

the formatted user

formatUserkey

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

Description copied from interface: UserFormatter

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.

Specified by:

formatUserkey in interface UserFormatter

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

public String formatUsername(String username,
 String id)

Description copied from interface: UserFormatter

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.

Specified by:

formatUsername in interface UserFormatter

Parameters:

username - the user to format.

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

Returns:

the formatted user

formatUsername

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

Description copied from interface: UserFormatter

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.

Specified by:

formatUsername in interface UserFormatter

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