Package org.xwiki.icon

Enum IconType

java.lang.Object

java.lang.Enum<IconType>

org.xwiki.icon.IconType

All Implemented Interfaces:

Serializable, Comparable<IconType>

public enum IconType
extends Enum<IconType>

All the types that an Icon can be.

Since:

6.2M1

Version:

$Id: 6ca664e7881857d027f203c029134b74b5632e69 $

Enum Constant Summary

Enum Constants

Enum Constant	Description
FONT	Icon displayed with a font.
IMAGE	Icon displayed with an image (an image HTML tag).

Method Summary

Modifier and Type	Method	Description
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

IMAGE

public static final IconType IMAGE

Icon displayed with an image (an image HTML tag).

FONT

public static final IconType FONT

Icon displayed with a font.

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