@PublicApi public interface

WebErrorMessage

com.atlassian.jira.plugin.user.WebErrorMessage
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

Interface to be used with user management plugin points to encapsulate error messages and a useful information for displaying those error messages to a user. An error message should contain a full sentence returned by getDescription(), a short snippet of a message to serve as a summary of the error message, and optionally a URI to link to further information when only the snippet is presented to the user.

Summary

Public Methods
String getDescription()
Returns a message containing the reason an error message has been generated.
String getSnippet()
Returns a short form of the error message that getDescription would provide.
URI getURI()
Returns a URI that can be used to direct users to pages with more information that can be tied to the snippet

Public Methods

public String getDescription ()

Returns a message containing the reason an error message has been generated.

Returns
  • an error message; must not be null

public String getSnippet ()

Returns a short form of the error message that getDescription would provide.

Returns
  • short form representation of getDescription; must not be null

public URI getURI ()

Returns a URI that can be used to direct users to pages with more information that can be tied to the snippet

Returns
  • a uri, or null if none is available