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

UserFormats

com.atlassian.jira.plugin.userformat.UserFormats
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).

Class Overview

Builds user formats for a specific user format type. User Formats are used to output user information from JIRA.

See Also

Summary

Public Methods
UserFormat forType(String type)
This method is deprecated. Use formatter(String) instead. Since v6.0.
UserFormatter formatter(String type)
Builds a user formatter for the specified type.

Public Methods

public UserFormat forType (String type)

This method is deprecated.
Use formatter(String) instead. Since v6.0.

Builds a user format for the specified type.

Parameters
type the type of user format to build.
Returns
  • A user format for the specified type or null if no user format could be found for the specfied type.

public UserFormatter formatter (String type)

Builds a user formatter for the specified type.

Parameters
type the type of user formatter to build.
Returns
  • A user formatter for the specified type or null if no user formatter could be found for the specfied type.