Package hudson.model

Interface StatusIcon

All Known Implementing Classes:
AbstractStatusIcon, BallColor, StockStatusIcon
public interface StatusIcon
Item can return this from the "getIconColor" method so that its "status icon" can be shown in Hudson UI.

For future compatibility, please extend from AbstractStatusIcon instead of implementing this directly, so that we can add methods later.

This is a generalization of BallColor.

Since:
1.390
Author:
Kohsuke Kawaguchi
See Also:

  • 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.

  • Method Details

    • getImageOf

      String getImageOf(String size)
      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

      String getDescription()
      Gets the human-readable description used as img/@alt.