Package com.atlassian.jira.plugin.profile

Interface UserFormat

All Known Implementing Classes:
CachingUserFormat, FullNameUserFormat, FullProfileUserFormat, ProfileLinkUserFormat, ReferenceFullNameUserFormat, SimpleProfileLinkUserFormat, UserNameUserFormat
@PublicSpi public interface UserFormat
Provides a format to display a user on screen. This may be simply the user's full name surrounded by a link to the user's profile, or something more advanced such as the user's name and profile picture.
Since:
v3.13
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    VIEW_TEMPLATE
    The default velocity template name that is used to render the view.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    format(String userkey, String id)
    Renders the formatted user for a given section on the screen.
    String
    format(String userkey, String id, Map<String,Object> params)
    Renders the formatted user for a given section on the screen.

  • Field Details

    • VIEW_TEMPLATE

      static final String VIEW_TEMPLATE
      The default velocity template name that is used to render the view.
      See Also:

  • Method Details

    • format

      String format(String userkey, String id)
      Renders the formatted user for a given section on the screen. Please note that the username may be null (eg for empty fields, anonymous user's, etc) or the user may not exist. Implementations should handle these cases.

      Extra context can be passed to the renderer via the id attribute. Ideally an implementation might include this id in the rendered output such that it can be used for test assertions.

      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's userkey to format.
      id - A value providing extra context to the rendering process.
      Returns:
      the formatted user

    • format

      String format(String userkey, String id, Map<String,Object> params)
      Renders the formatted user for a given section on the screen. Please note that the username may be null (eg for empty fields, anonymous user's, etc) or the user may not exist. Implementations should handle these cases.

      Extra context can be passed to the renderer via the params attribute.

      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's userkey to format.
      id - A value providing extra context to the rendering process.
      params - Additional context to pass to the renderer
      Returns:
      the formatted user