org.xwiki.rendering.listener
Enum HeaderLevel

java.lang.Object
  java.lang.Enum<HeaderLevel>
      org.xwiki.rendering.listener.HeaderLevel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HeaderLevel>

public enum HeaderLevel
extends java.lang.Enum<HeaderLevel>

Since:

1.5M2

Version:

$Id$

Enum Constant Summary

LEVEL1
Header of level 1.

LEVEL2
Header of level 2.

LEVEL3
Header of level 3.

LEVEL4
Header of level 4.

LEVEL5
Header of level 5.

LEVEL6
Header of level 6.

Method Summary

int	getAsInt()
static HeaderLevel	parseInt(int value) Convert provided integer into the corresponding header level enum entry.
java.lang.String	toString()
static HeaderLevel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HeaderLevel[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEVEL1

public static final HeaderLevel LEVEL1

Header of level 1.

LEVEL2

public static final HeaderLevel LEVEL2

Header of level 2.

LEVEL3

public static final HeaderLevel LEVEL3

Header of level 3.

LEVEL4

public static final HeaderLevel LEVEL4

Header of level 4.

LEVEL5

public static final HeaderLevel LEVEL5

Header of level 5.

LEVEL6

public static final HeaderLevel LEVEL6

Header of level 6.

Method Detail

values

public static final HeaderLevel[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(HeaderLevel c : HeaderLevel.values())
        System.out.println(c);

Returns:

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

valueOf

public static HeaderLevel valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getAsInt

public int getAsInt()

Returns:

the header level as integer

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<HeaderLevel>

See Also:

Enum.toString()

parseInt

public static HeaderLevel parseInt(int value)

Convert provided integer into the corresponding header level enum entry.

Parameters:

value - the header level as integer

Returns:

the header level as enum entry