hudson.model.StatusIcon Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hudson-core Show documentation
Contains the core Hudson code and view files to render HTML.
The newest version!
/*******************************************************************************
 *
 * Copyright (c) 2010, CloudBees, Inc.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors: 
 *     
 *
 *******************************************************************************/ 

/*
 * The MIT License
 *
 * Copyright (c) 2010, CloudBees, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package hudson.model;

/**
 * {@link 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 {@link AbstractStatusIcon}
 * instead of implementing this directly, so that we can add methods later.
 *
 * 
 * This is a generalization of {@link BallColor}.
 *
 * @author Kohsuke Kawaguchi
 * @since 1.390
 * @see StockStatusIcon
 */
public interface StatusIcon {
    /**
     * Returns the URL to the image.
     *
     * @param 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.)
     * @return
     *      The URL is rendered as is in the img @src attribute, so it must contain
     *      the context path, etc.
     */
    String getImageOf(String size);

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