com.atlassian.jira.avatar

Enum RequestedAvatarFormat

java.lang.Object

java.lang.Enum<RequestedAvatarFormat>

com.atlassian.jira.avatar.RequestedAvatarFormat

All Implemented Interfaces:

Serializable, Comparable<RequestedAvatarFormat>

@ExperimentalApi
public enum RequestedAvatarFormat
extends Enum<RequestedAvatarFormat>

Used to request a specific format of an avatar image.

Since:

v7.0.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT This will always use the actual content type of the avatar
PNG If the avatar is a PNG, or can be converted then this will use png format, otherwise it will use the actual content type of the avatar.

Method Summary

Modifier and Type	Method and Description
abstract javax.mail.internet.ContentType	getResponseContentType(Avatar avatar) Gets a mime type that should be used for the avatar if requesting to read the image data in this format.
abstract boolean	isSupportedBy(Avatar avatar) Returns true if the given avatar supports this format.
static RequestedAvatarFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static RequestedAvatarFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final RequestedAvatarFormat DEFAULT

This will always use the actual content type of the avatar

PNG

public static final RequestedAvatarFormat PNG

If the avatar is a PNG, or can be converted then this will use png format, otherwise it will use the actual content type of the avatar.

Method Detail

values

public static RequestedAvatarFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RequestedAvatarFormat c : RequestedAvatarFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RequestedAvatarFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getResponseContentType

public abstract javax.mail.internet.ContentType getResponseContentType(@Nonnull
                                                                       Avatar avatar)

Gets a mime type that should be used for the avatar if requesting to read the image data in this format. This will always return a value, never null, that can safely be used as the content type on any response. If isSupportedBy(Avatar) returns true then this will return the content type requested, otherwise it will return the actual content type of the avatar.

Parameters:

avatar - avatar that is returned in the response

Returns:

proper content-type to use

Throws:

RuntimeException - if the avatars content type is invalid

isSupportedBy

public abstract boolean isSupportedBy(@Nonnull
                                      Avatar avatar)

Returns true if the given avatar supports this format. If the avatar is already in the expected format, this will be true. Otherwise if the format would require converting, it will be true if this is possible, otherwise false.

Parameters:

avatar - avatar that want to see if supported

Returns:

true if this is supported or can be converted successfully, false otherwise