com.atlassian.jira.avatar

Interface Avatar

All Known Implementing Classes:

AvatarImpl, MockAvatar

@PublicApi
public interface Avatar

Represents an icon for a project or some other entity in JIRA.

Since:

v4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Avatar.Size The standard sizes for avatars.
static class	Avatar.Type An indicator of the owner type of the avatar.

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	demotedSystemProjectAvatars These are the filenames of avatars that used to be available as system avatars, but were to be removed from the list of avatar options available to new projects.

Method Summary

Methods

Modifier and Type	Method and Description
Avatar.Type	getAvatarType() The type of Avatar.
String	getContentType() The MIME type of the avatar image file.
String	getFileName() The base filename to the avatar image file.
Long	getId() The database identifier for the Avatar, may be null if it hasn't yet been stored or if database identifiers are not supported.
String	getOwner() A String representation of the identity of the domain object that this avatar is an avatar for! For example, if it is a user avatar, it would be the username (since that is the primary key), for a Project it is the project ID as a String.
boolean	isSystemAvatar() Indicates whether the Avatar is a system-provided one or if users have defined it.

Field Detail

demotedSystemProjectAvatars

static final List<String> demotedSystemProjectAvatars

These are the filenames of avatars that used to be available as system avatars, but were to be removed from the list of avatar options available to new projects.

Method Detail

getAvatarType

@Nonnull
Avatar.Type getAvatarType()

The type of Avatar.

Returns:

a non null Avatar.Type.

getFileName

@Nonnull
String getFileName()

The base filename to the avatar image file. The actual file name will be modified with the id etc.

Returns:

the non null file name.

getContentType

@Nonnull
String getContentType()

The MIME type of the avatar image file.

Returns:

the non null file name.

getId

Long getId()

The database identifier for the Avatar, may be null if it hasn't yet been stored or if database identifiers are not supported. This will always return null for user avatars in some deployment configurations. Avatars for other purposes (e.g. Projects) may follow this in future versions and this method will be deprecated entirely. The id should not be used to construct URLs to the currently-configured avatar for anything. This method should only be used when it is necessary to refer to an avatar that is not currently the configured avatar for the domain object. The only use cases where this is needed are those to do with modifying or viewing detailed avatar configuration.

Returns:

the database id or null.

getOwner

@Nonnull
String getOwner()

A String representation of the identity of the domain object that this avatar is an avatar for! For example, if it is a user avatar, it would be the username (since that is the primary key), for a Project it is the project ID as a String. The meaning of this should be determined by the Avatar.Type.

Returns:

the owner id must not be null.

isSystemAvatar

boolean isSystemAvatar()

Indicates whether the Avatar is a system-provided one or if users have defined it.

Returns:

true only if the Avatar is a system-provided one.