HeaderLevel (XWiki Rendering - Api 13.6-rc-1 API)

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

All Implemented Interfaces:

Serializable, Comparable<HeaderLevel>
```
public enum HeaderLevel
extends Enum<HeaderLevel>
```
Since:

1.5M2

Version:

$Id: 300cdcbd02ce26ea7f648d7aec2b224a92334745 $

Enum Constant Summary

Enum Constants
Enum Constant and Description
`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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAsInt()`
`static HeaderLevel`	`parseInt(int value)` Convert provided integer into the corresponding header level enum entry.
`String`	`toString()`
`static HeaderLevel`	`valueOf(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 are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
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 HeaderLevel[] 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 (HeaderLevel c : HeaderLevel.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HeaderLevel 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
  - getAsInt
```
public int getAsInt()
```
    Returns:
    
    the header level as integer
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<HeaderLevel>
  - 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

Enum HeaderLevel

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

LEVEL1

LEVEL2

LEVEL3

LEVEL4

LEVEL5

LEVEL6

Method Detail

values

valueOf

getAsInt

toString

parseInt