Package hudson.model

Class StockStatusIcon

java.lang.Object

hudson.model.AbstractStatusIcon

hudson.model.StockStatusIcon

All Implemented Interfaces:

StatusIcon

public final class StockStatusIcon
extends AbstractStatusIcon

StatusIcon for stock icon in Hudson.

Since:

1.390.

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor	Description
StockStatusIcon(String image, org.jvnet.localizer.Localizable description)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the human-readable description used as img/@alt.
String	getImageOf(String size)	Returns the URL to the image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StockStatusIcon

public StockStatusIcon(String image,
                       org.jvnet.localizer.Localizable description)

Parameters:

image - Short file name like "folder.gif" that points to a stock icon in Hudson.

description - Used as getDescription().

Method Detail

getImageOf

public String getImageOf(String size)

Description copied from interface: StatusIcon

Returns the URL to the image.

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()

Description copied from interface: StatusIcon

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