org.jenkins.ui.icon
Enum IconType

java.lang.Object
  java.lang.Enum<IconType>
      org.jenkins.ui.icon.IconType

All Implemented Interfaces:

Serializable, Comparable<IconType>

public enum IconType
extends Enum<IconType>

Icon type.

Author:

tom.fennelly@gmail.com

Enum Constant Summary

CORE

PLUGIN

Method Summary

String	toQualifiedUrl(String url) Qualify the supplied icon url.
String	toQualifiedUrl(String url, org.apache.commons.jelly.JellyContext context) Qualify the supplied icon url.
String	toQualifiedUrl(String url, String resURL) Qualify the supplied icon url.
static IconType	valueOf(String name) Returns the enum constant of this type with the specified name.
static IconType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CORE

public static final IconType CORE

PLUGIN

public static final IconType PLUGIN

Method Detail

values

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

Returns:

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

valueOf

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

toQualifiedUrl

public String toQualifiedUrl(String url,
                             org.apache.commons.jelly.JellyContext context)

Qualify the supplied icon url.

Qualifying the URL involves prefixing it depending on whether the icon is a core or plugin icon.

Parameters:

url - The url to be qualified.

context - The JellyContext.

Returns:

The qualified icon url.

toQualifiedUrl

public String toQualifiedUrl(String url)

Qualify the supplied icon url.

Qualifying the URL involves prefixing it depending on whether the icon is a core or plugin icon. Uses the current StaplerRequest instance to resolve the Jenkins resource URL.

Parameters:

url - The url to be qualified.

Returns:

The qualified icon url.

toQualifiedUrl

public String toQualifiedUrl(String url,
                             String resURL)

Qualify the supplied icon url.

Qualifying the URL involves prefixing it depending on whether the icon is a core or plugin icon.

Parameters:

url - The url to be qualified.

resURL - The resource url prefix.

Returns:

The qualified icon url.