Package org.xwiki.rendering.macro.figure

Enum FigureType

java.lang.Object

java.lang.Enum<FigureType>

org.xwiki.rendering.macro.figure.FigureType

All Implemented Interfaces:

Serializable, Comparable<FigureType>

@Unstable
public enum FigureType
extends Enum<FigureType>

Allowed figure types.

Since:

14.9RC1

Version:

$Id: 35e3ba1d892614df2576fae0922c463bfa15b3d9 $

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTOMATIC	Implicit type, let the type be defined according to the body of the figure.
FIGURE	Explicit figure type.
TABLE	Explicit table type.

Method Summary

Modifier and Type	Method	Description
String	getName()
static FigureType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FigureType[]	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

AUTOMATIC

public static final FigureType AUTOMATIC

Implicit type, let the type be defined according to the body of the figure.

See Also:

FigureTypeRecognizer

FIGURE

public static final FigureType FIGURE

Explicit figure type.

TABLE

public static final FigureType TABLE

Explicit table type.

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

Returns:

the name of the figure type (e.g., FIGURE)