Package com.atlassian.jira.plugin.profile

Interface UserFormatManager

All Known Implementing Classes:
DefaultUserFormatManager
@Deprecated public interface UserFormatManager
Deprecated.
please use UserFormats instead.
Manages the UserFormat to type mapping. UserFormat modules may be provided for various different types.
See Also:

  • Method Details

    • getUserFormat

      UserFormat getUserFormat(String type)
      Deprecated.
      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

    • getUserFormatter

      UserFormatter getUserFormatter(String type)
      Deprecated.
      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
      Since:
      6.0

    • formatUser

      String formatUser(String username, String type, String id)
      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.

    • formatUsername

      String formatUsername(String username, String type, String id)
      Deprecated.
      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.
      Since:
      6.0

    • formatUserkey

      String formatUserkey(String userkey, String type, String id)
      Deprecated.
      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.
      Since:
      6.0

    • formatUser

      String formatUser(String username, String type, String id, Map params)
      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.

    • formatUsername

      String formatUsername(String username, String type, String id, Map params)
      Deprecated.
      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.
      Since:
      6.0

    • formatUserkey

      String formatUserkey(String userkey, String type, String id, Map params)
      Deprecated.
      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.
      Since:
      6.0