Summary: Methods | [Expand All]
@PublicApi public interface

UserFormatter

com.atlassian.jira.plugin.userformat.UserFormatter
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Summary

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.

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