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

UserFormatManager

com.atlassian.jira.plugin.profile.UserFormatManager
Known Indirect Subclasses

This interface is deprecated.
please use UserFormats instead.

Class Overview

Manages the UserFormat to type mapping. UserFormat modules may be provided for various different types.

See Also

Summary

Public Methods
String formatUser(String username, String type, String id)
This method is deprecated. Use formatUserkey(String, String, String) or formatUsername(String, String, String) instead. Since v6.0.
String formatUser(String username, String type, String id, Map params)
This method is deprecated. Use formatUserkey(String, String, String, java.util.Map) or formatUsername(String, String, String, java.util.Map) instead. Since v6.0.
String formatUserkey(String userkey, String type, String id, Map params)
Convenience method to format a given user.
String formatUserkey(String userkey, String type, String id)
Convenience method to format a given user.
String formatUsername(String username, String type, String id)
Convenience method to format a given user.
String formatUsername(String username, String type, String id, Map params)
Convenience method to format a given user.
UserFormat getUserFormat(String type)
Returns the UserFormat for a specific type, or null if none exists
UserFormatter getUserFormatter(String type)
Returns the UserFormat for a specific type, or null if none exists

Public Methods

public String formatUser (String username, String type, String id)

This method is deprecated.
Use formatUserkey(String, String, String) or formatUsername(String, String, String) instead. Since v6.0.

Convenience method to format a given user. Method looks up the mapped user format for the type and passes the username and id to this user format. Returns null if no mapped user format can be found.

Parameters
username The user to format
type The user format type to use
id A context sensitive id
Returns
  • formatted user or null.

public String formatUser (String username, String type, String id, Map params)

This method is deprecated.
Use formatUserkey(String, String, String, java.util.Map) or formatUsername(String, String, String, java.util.Map) instead. Since v6.0.

Convenience method to format a given user. The params user allows a user to pass any information needed for additional context to the underlying UserFormat.

Parameters
username The user to format
type The user format type to use
id A context sensitive id
params Additional context to provide to the userformatter.
Returns
  • formatted user or null.

public String formatUserkey (String userkey, String type, String id, Map params)

Convenience method to format a given user. The params user allows a user to pass any information needed for additional context to the underlying UserFormat.

Parameters
userkey The key of the user to format
type The user format type to use
id A context sensitive id
params Additional context to provide to the userformatter.
Returns
  • formatted user or null.

public String formatUserkey (String userkey, String type, String id)

Convenience method to format a given user. Method looks up the mapped user format for the type and passes the user key and id to this user format. Returns null if no mapped user format can be found.

Parameters
userkey The key of the user to format
type The user format type to use
id A context sensitive id
Returns
  • formatted user or null.

public String formatUsername (String username, String type, String id)

Convenience method to format a given user. Method looks up the mapped user format for the type and passes the username and id to this user format. Returns null if no mapped user format can be found.

Parameters
username The key of the user to format
type The user format type to use
id A context sensitive id
Returns
  • formatted user or null.

public String formatUsername (String username, String type, String id, Map params)

Convenience method to format a given user. The params user allows a user to pass any information needed for additional context to the underlying UserFormat.

Parameters
username The key of the user to format
type The user format type to use
id A context sensitive id
params Additional context to provide to the userformatter.
Returns
  • formatted user or null.

public UserFormat getUserFormat (String type)

Returns the UserFormat for a specific type, or null if none exists

Parameters
type the specific type for which to find a UserFormat.
Returns
  • the UserFormat for a specific type, or null if none exists

public UserFormatter getUserFormatter (String type)

Returns the UserFormat for a specific type, or null if none exists

Parameters
type the specific type for which to find a UserFormat.
Returns
  • the UserFormat for a specific type, or null if none exists