com.atlassian.jira.avatar
Enum Avatar.Size

java.lang.Object
  java.lang.Enum<Avatar.Size>
      com.atlassian.jira.avatar.Avatar.Size

All Implemented Interfaces:

Serializable, Comparable<Avatar.Size>

Enclosing interface:

Avatar

public static enum Avatar.Size
extends Enum<Avatar.Size>

The standard sizes for avatars.

Enum Constant Summary

LARGE
A large avatar (48x48 pixels).

MEDIUM
A medium avatar (32x32 pixels).

NORMAL
A small avatar (24x24 pixels).

RETINA_XXLARGE

RETINA_XXXLARGE

SMALL
An extra-small avatar (16x16 pixels).

XLARGE

XXLARGE

XXXLARGE

Method Summary

static Avatar.Size	biggerThan(int pixelValue)
static Avatar.Size	defaultSize()
String	getParam()
int	getPixels()
static Avatar.Size	largest() In order to cater for future addition of larger sizes this method finds the largest image size.
static Avatar.Size	smallerThan(int pixelValue)
String	toString()
static Avatar.Size	valueOf(String name) Returns the enum constant of this type with the specified name.
static Avatar.Size[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final Avatar.Size NORMAL

A small avatar (24x24 pixels). Use when outputting user's names.

SMALL

public static final Avatar.Size SMALL

An extra-small avatar (16x16 pixels).

MEDIUM

public static final Avatar.Size MEDIUM

A medium avatar (32x32 pixels). Use in comments and other activity streams.

LARGE

public static final Avatar.Size LARGE

A large avatar (48x48 pixels).

XLARGE

public static final Avatar.Size XLARGE

XXLARGE

public static final Avatar.Size XXLARGE

XXXLARGE

public static final Avatar.Size XXXLARGE

RETINA_XXLARGE

public static final Avatar.Size RETINA_XXLARGE

RETINA_XXXLARGE

public static final Avatar.Size RETINA_XXXLARGE

Method Detail

values

public static Avatar.Size[] 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 (Avatar.Size c : Avatar.Size.values())
    System.out.println(c);

Returns:

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

valueOf

public static Avatar.Size 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

largest

public static Avatar.Size largest()

In order to cater for future addition of larger sizes this method finds the largest image size.

Returns:

The largest Size

See Also:

com.atlassian.jira.avatar.AvatarManager.ImageSize#largest()}, they need to be kept in sync.

defaultSize

public static Avatar.Size defaultSize()

Returns:

the default size for avatars.

See Also:

com.atlassian.jira.avatar.AvatarManager.ImageSize#defaultSize()}, they need to be kept in sync.

biggerThan

public static Avatar.Size biggerThan(int pixelValue)

Parameters:

pixelValue - minimum number of pixels tall+wide the avatar size should be

Returns:

an avatar Avatar.Size that's equal to or larger than the pixelValue, or null if there's no size that could cater the value.

smallerThan

public static Avatar.Size smallerThan(int pixelValue)

Parameters:

pixelValue - minimum number of pixels tall+wide the avatar size should be

Returns:

an avatar Avatar.Size that's equal to or larger than the pixelValue, or null if there's no size that could cater the value.

getPixels

public int getPixels()

getParam

public String getParam()

toString

public String toString()

Overrides:

toString in class Enum<Avatar.Size>