@PublicApi public interface

ThumbnailedImage

com.atlassian.jira.issue.thumbnail.ThumbnailedImage

@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

JIRA-specific thunbnailed image interface. A ThumbnailedImage contains methods for getting its URL, etc.

See Also

Summary

Public Methods
long getAttachmentId()
String getFilename()
int getHeight()
String getImageURL()
String getMimeType()
int getWidth()

Public Methods

public long getAttachmentId ()

Returns
  • the id of the attachment

public String getFilename ()

Returns
  • the name of the image file

public int getHeight ()

Returns
  • the height of the image, in pixels

public String getImageURL ()

Returns
  • the URL for this thumbnail image. If running in the context of a web request, this will return a url relative to the server root (ie "/jira/"). If running via email, it will return an absolute URL (eg. "http://example.com/jira/").

public String getMimeType ()

Returns
  • the MIME type of the image

public int getWidth ()

Returns
  • the width of the image, in pixels