com.atlassian.jira.dev.reference.plugin.userformat
Class ReferenceFullNameUserFormat
java.lang.Object
com.atlassian.jira.dev.reference.plugin.userformat.ReferenceFullNameUserFormat
- All Implemented Interfaces:
- UserFormat
public class ReferenceFullNameUserFormat
- extends Object
- implements UserFormat
Reference implementation that renders the users full name between brackets.
- Since:
- v4.4
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ReferenceFullNameUserFormat
public ReferenceFullNameUserFormat(UserUtil userUtil)
format
public String format(String key,
String id)
- Description copied from interface:
UserFormat
- 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.
- Specified by:
format
in interface UserFormat
- Parameters:
key
- the user's userkey to format.id
- A value providing extra context to the rendering process.
- Returns:
- the formatted user
format
public String format(String key,
String id,
Map<String,Object> params)
- Description copied from interface:
UserFormat
- 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.
- Specified by:
format
in interface UserFormat
- Parameters:
key
- 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
Copyright © 2002-2013 Atlassian. All Rights Reserved.