hudson.model
Enum BallColor

java.lang.Object
  java.lang.Enum<BallColor>
      hudson.model.BallColor

All Implemented Interfaces:

StatusIcon, Serializable, Comparable<BallColor>

public enum BallColor
extends Enum<BallColor>
implements StatusIcon

Ball color used for the build status indication.

There are four basic colors, plus their animated "bouncy" versions. Enum.ordinal() is the sort order.

Note that multiple BallColor instances may map to the same RGB color, to avoid the rainbow effect.

Historical Note

Hudson started to overload colors — for example grey could mean either disabled, aborted, or not yet built. As a result, BallColor becomes more like a "logical" color, in the sense that different BallColor values can map to the same RGB color. See issue #956.

Author:

Kohsuke Kawaguchi

Enum Constant Summary

ABORTED

ABORTED_ANIME

BLUE

BLUE_ANIME

DISABLED

DISABLED_ANIME

GREY

GREY_ANIME

NOTBUILT

NOTBUILT_ANIME

RED

RED_ANIME

YELLOW

YELLOW_ANIME

Method Summary

BallColor	anime() Gets the animated version.
Color	getBaseColor() Gets the RGB color of this color.
String	getDescription() Gets the human-readable description used as img/@alt.
String	getHtmlBaseColor() Returns the getBaseColor() in the "#RRGGBB" format.
String	getImage() String like "red.png" that represents the file name of the image.
String	getImageOf(String size) Returns the URL to the image.
boolean	isAnimated() True if the icon is animated.
BallColor	noAnime() Gets the unanimated version.
String	toString() Also used as a final name.
static BallColor	valueOf(String name) Returns the enum constant of this type with the specified name.
static BallColor[]	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

RED

public static final BallColor RED

RED_ANIME

public static final BallColor RED_ANIME

YELLOW

public static final BallColor YELLOW

YELLOW_ANIME

public static final BallColor YELLOW_ANIME

BLUE

public static final BallColor BLUE

BLUE_ANIME

public static final BallColor BLUE_ANIME

GREY

public static final BallColor GREY

GREY_ANIME

public static final BallColor GREY_ANIME

DISABLED

public static final BallColor DISABLED

DISABLED_ANIME

public static final BallColor DISABLED_ANIME

ABORTED

public static final BallColor ABORTED

ABORTED_ANIME

public static final BallColor ABORTED_ANIME

NOTBUILT

public static final BallColor NOTBUILT

NOTBUILT_ANIME

public static final BallColor NOTBUILT_ANIME

Method Detail

values

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

Returns:

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

valueOf

public static BallColor 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

getImage

public String getImage()

String like "red.png" that represents the file name of the image.

getImageOf

public String getImageOf(String size)

Description copied from interface: StatusIcon

Returns the URL to the image.

Specified by:

getImageOf in interface StatusIcon

Parameters:

size - The size specified. Must support "16x16", "24x24", and "32x32" at least. For forward compatibility, if you receive a size that's not supported, consider returning your biggest icon (and let the browser rescale.)

Returns:

The URL is rendered as is in the img @src attribute, so it must contain the context path, etc.

getDescription

public String getDescription()

Gets the human-readable description used as img/@alt.

Specified by:

getDescription in interface StatusIcon

getBaseColor

public Color getBaseColor()

Gets the RGB color of this color. Animation effect is not reflected to this value.

getHtmlBaseColor

public String getHtmlBaseColor()

Returns the getBaseColor() in the "#RRGGBB" format.

toString

public String toString()

Also used as a final name.

Overrides:

toString in class Enum<BallColor>

anime

public BallColor anime()

Gets the animated version.

noAnime

public BallColor noAnime()

Gets the unanimated version.

isAnimated

public boolean isAnimated()

True if the icon is animated.