com.atlassian.jira.avatar

Interface AvatarTagger

All Known Implementing Classes:

AvatarTaggerImpl

public interface AvatarTagger

Saves an image as a png with metadata signifying this image is a JIRA Avatar (used by the email handler to decide whether or not to attach an image)

Since:

v6.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	AVATAR_SYSTEM_IMAGE_TYPE
static String	JIRA_SYSTEM_IMAGE_TYPE

Method Summary

Modifier and Type	Method and Description
void	saveTaggedAvatar(RenderedImage image, String name, File file) Adds JIRA specific metadata to given image.
void	saveTaggedAvatar(RenderedImage image, String targetFormat, OutputStream target) Adds JIRA specific metadata to given image.
void	tag(InputStream inputStream, OutputStream outputStream) Add JIRA specific metadata to given file.
String	tagAvatar(long id, String filename) Adds JIRA specific metadata to all avatar thumbnails.
void	tagSingleAvatarFile(File source, File destination) Add JIRA specific metadata to given file.

Field Detail

JIRA_SYSTEM_IMAGE_TYPE

static final String JIRA_SYSTEM_IMAGE_TYPE

See Also:

Constant Field Values

AVATAR_SYSTEM_IMAGE_TYPE

static final String AVATAR_SYSTEM_IMAGE_TYPE

See Also:

Constant Field Values

Method Detail

saveTaggedAvatar

void saveTaggedAvatar(RenderedImage image,
                      String name,
                      File file)
               throws IOException

Adds JIRA specific metadata to given image. The saved image will have PNG format.

Parameters:

image - to be tagged

name - of the image

file - in which the tagged image will be saved

Throws:

IOException

tagAvatar

String tagAvatar(long id,
                 String filename)
          throws IOException

Adds JIRA specific metadata to all avatar thumbnails.

Parameters:

id - of the avatar

filename - of the avatar main image

Returns:

the name of tagged avatar image

Throws:

IOException

saveTaggedAvatar

void saveTaggedAvatar(RenderedImage image,
                      String targetFormat,
                      OutputStream target)
               throws IOException

Adds JIRA specific metadata to given image.

Parameters:

image - to be tagged

targetFormat - in which image will be saved

target - output in which the tagged image will be saved

Throws:

IOException

tagSingleAvatarFile

void tagSingleAvatarFile(File source,
                         File destination)
                  throws IOException

Add JIRA specific metadata to given file.

Parameters:

source - file to be tagged

destination - in which the tagged file will be saved

Throws:

IOException

tag

void tag(InputStream inputStream,
         OutputStream outputStream)
  throws IOException

Add JIRA specific metadata to given file.

Parameters:

inputStream - pointing to the source which will be tagged

outputStream - pointing where the tagged file should be written

Throws:

IOException